Annotation of loncom/interface/lonstatistics.pm, revision 1.113

1.1       albertel    1: # The LearningOnline Network with CAPA
                      2: #
1.113   ! matthew     3: # $Id: lonstatistics.pm,v 1.112 2005/01/05 20:34:20 matthew Exp $
1.1       albertel    4: #
                      5: # Copyright Michigan State University Board of Trustees
                      6: #
                      7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      8: #
                      9: # LON-CAPA is free software; you can redistribute it and/or modify
                     10: # it under the terms of the GNU General Public License as published by
                     11: # the Free Software Foundation; either version 2 of the License, or
                     12: # (at your option) any later version.
                     13: #
                     14: # LON-CAPA is distributed in the hope that it will be useful,
                     15: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     16: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     17: # GNU General Public License for more details.
                     18: #
                     19: # You should have received a copy of the GNU General Public License
                     20: # along with LON-CAPA; if not, write to the Free Software
                     21: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     22: #
                     23: # /home/httpd/html/adm/gpl.txt
                     24: #
                     25: # http://www.lon-capa.org/
                     26: #
                     27: # (Navigate problems for statistical reports
1.14      minaeibi   28: #
1.1       albertel   29: ###
                     30: 
1.59      matthew    31: =pod
                     32: 
                     33: =head1 NAME
                     34: 
                     35: lonstatistics
                     36: 
                     37: =head1 SYNOPSIS
                     38: 
                     39: Main handler for statistics and chart.
                     40: 
                     41: =over 4
                     42: 
                     43: =cut
                     44: 
1.55      minaeibi   45: package Apache::lonstatistics;
1.1       albertel   46: 
1.30      stredwic   47: use strict;
1.1       albertel   48: use Apache::Constants qw(:common :http);
1.61      matthew    49: use vars qw(
                     50:     @FullClasslist 
                     51:     @Students
                     52:     @Sections 
                     53:     @SelectedSections
                     54:     %StudentData
                     55:     @StudentDataOrder
                     56:     @SelectedStudentData
                     57:     $top_map 
                     58:     @Sequences 
                     59:     @SelectedMaps
1.94      matthew    60:     @Assessments
                     61:     $enrollment_status);
1.61      matthew    62: 
1.1       albertel   63: use Apache::lonnet();
                     64: use Apache::lonhomework;
1.12      minaeibi   65: use Apache::loncommon;
1.29      stredwic   66: use Apache::loncoursedata;
                     67: use Apache::lonhtmlcommon;
1.97      matthew    68: use Apache::lonmysql;
                     69: use Apache::lonlocal;
                     70: use Time::HiRes;
                     71: #
                     72: # Statistics Packages
1.61      matthew    73: use Apache::lonproblemanalysis();
1.89      matthew    74: use Apache::lonsubmissiontimeanalysis();
1.94      matthew    75: use Apache::loncorrectproblemplot();
1.61      matthew    76: use Apache::lonproblemstatistics();
                     77: use Apache::lonstudentassessment();
1.49      stredwic   78: use Apache::lonpercentage;
1.97      matthew    79: use Apache::lonstudentsubmissions();
1.104     matthew    80: use Apache::lonsurveyreports();
1.60      matthew    81: 
                     82: #######################################################
                     83: #######################################################
                     84: 
                     85: =pod
                     86: 
                     87: =item Package Variables
                     88: 
                     89: =item @FullClasslist The full classlist
                     90: 
                     91: =item @Students The students we are concerned with for this invocation
                     92: 
                     93: =item @Sections The sections available in this class
                     94: 
                     95: =item $curr_student The student currently being examined
                     96: 
                     97: =item $prev_student The student previous in the classlist
                     98: 
                     99: =item $next_student The student next in the classlist
                    100: 
                    101: =over
                    102: 
                    103: =cut 
                    104: 
                    105: #######################################################
                    106: #######################################################
                    107: #
                    108: # Classlist variables
                    109: #
1.59      matthew   110: my $curr_student;
                    111: my $prev_student;
                    112: my $next_student;
                    113: 
                    114: #######################################################
                    115: #######################################################
                    116: 
                    117: =pod
                    118: 
                    119: =item &clear_classlist_variables()
                    120: 
                    121: undef the following package variables:
                    122: 
                    123: =over
                    124: 
1.60      matthew   125: =item @FullClasslist
                    126: 
                    127: =item @Students
1.59      matthew   128: 
1.60      matthew   129: =item @Sections
1.59      matthew   130: 
1.60      matthew   131: =item @SelectedSections
1.59      matthew   132: 
1.61      matthew   133: =item %StudentData
                    134: 
                    135: =item @StudentDataOrder
                    136: 
                    137: =item @SelectedStudentData
                    138: 
1.60      matthew   139: =item $curr_student
1.59      matthew   140: 
1.60      matthew   141: =item $prev_student
1.59      matthew   142: 
1.60      matthew   143: =item $next_student
1.59      matthew   144: 
                    145: =back
                    146: 
                    147: =cut
                    148: 
                    149: #######################################################
                    150: #######################################################
                    151: sub clear_classlist_variables {
                    152:     undef(@FullClasslist);
                    153:     undef(@Students);
                    154:     undef(@Sections);
1.60      matthew   155:     undef(@SelectedSections);
1.61      matthew   156:     undef(%StudentData);
                    157:     undef(@SelectedStudentData);
1.59      matthew   158:     undef($curr_student);
                    159:     undef($prev_student);
                    160:     undef($next_student);
                    161: }
                    162: 
                    163: #######################################################
                    164: #######################################################
                    165: 
                    166: =pod
                    167: 
                    168: =item &PrepareClasslist()
                    169: 
                    170: Build up the classlist information.  The classlist information is kept in
                    171: the following package variables:
                    172: 
                    173: =over
                    174: 
1.60      matthew   175: =item @FullClasslist
                    176: 
                    177: =item @Students
1.59      matthew   178: 
1.60      matthew   179: =item @Sections
1.59      matthew   180: 
1.60      matthew   181: =item @SelectedSections
1.59      matthew   182: 
1.61      matthew   183: =item %StudentData
                    184: 
                    185: =item @SelectedStudentData
                    186: 
1.60      matthew   187: =item $curr_student
1.59      matthew   188: 
1.60      matthew   189: =item $prev_student
1.59      matthew   190: 
1.60      matthew   191: =item $next_student
1.59      matthew   192: 
                    193: =back
                    194: 
                    195: $curr_student, $prev_student, and $next_student may not be defined, depending
                    196: upon the calling context.
                    197: 
                    198: =cut
                    199: 
                    200: #######################################################
                    201: #######################################################
                    202: sub PrepareClasslist {
                    203:     my %Sections;
                    204:     &clear_classlist_variables();
                    205:     #
                    206:     # Retrieve the classlist
                    207:     my $cid  = $ENV{'request.course.id'};
                    208:     my $cdom = $ENV{'course.'.$cid.'.domain'};
                    209:     my $cnum = $ENV{'course.'.$cid.'.num'};
                    210:     my ($classlist,$field_names) = &Apache::loncoursedata::get_classlist($cid,
                    211:                                                                   $cdom,$cnum);
1.60      matthew   212:     if (exists($ENV{'form.Section'})) {
1.59      matthew   213:         if (ref($ENV{'form.Section'})) {
1.61      matthew   214:             @SelectedSections = @{$ENV{'form.Section'}};
                    215:         } elsif ($ENV{'form.Section'} !~ /^\s*$/) {
                    216:             @SelectedSections = ($ENV{'form.Section'});
                    217:         }
                    218:     }
                    219:     @SelectedSections = ('all') if (! @SelectedSections);
                    220:     foreach (@SelectedSections) {
                    221:         if ($_ eq 'all') {
                    222:             @SelectedSections = ('all');
1.59      matthew   223:         }
                    224:     }
1.61      matthew   225:     #
1.69      matthew   226:     # Deal with instructors with restricted section access
1.70      matthew   227:     if ($ENV{'request.course.sec'} !~ /^\s*$/) {
1.69      matthew   228:         @SelectedSections = ($ENV{'request.course.sec'});
                    229:     }
                    230:     #
1.61      matthew   231:     # Set up %StudentData
1.108     matthew   232:     @StudentDataOrder = qw/fullname username domain id section status comments/;
1.61      matthew   233:     foreach my $field (@StudentDataOrder) {
1.108     matthew   234:         $StudentData{$field}->{'title'} = &mt($field);
                    235:         $StudentData{$field}->{'base_width'} = length(&mt($field));
1.61      matthew   236:         $StudentData{$field}->{'width'} = 
                    237:                                $StudentData{$field}->{'base_width'};
                    238:     }
1.59      matthew   239:     #
1.68      matthew   240:     # get the status requested
1.94      matthew   241:     $enrollment_status = 'Active';
                    242:     $enrollment_status = $ENV{'form.Status'} if (exists($ENV{'form.Status'}));
1.68      matthew   243:     #
1.59      matthew   244:     # Process the classlist
                    245:     while (my ($student,$student_data) = each (%$classlist)) {
                    246:         my $studenthash = ();
                    247:         for (my $i=0; $i< scalar(@$field_names);$i++) {
1.61      matthew   248:             my $field = $field_names->[$i];
                    249:             # Store the data
                    250:             $studenthash->{$field}=$student_data->[$i];
                    251:             # Keep track of the width of the fields
                    252:             next if (! exists($StudentData{$field}));
1.63      matthew   253:             my $length = length($student_data->[$i]);
1.61      matthew   254:             if ($StudentData{$field}->{'width'} < $length) {
                    255:                 $StudentData{$field}->{'width'} = $length; 
                    256:             }
1.59      matthew   257:         }
                    258:         push (@FullClasslist,$studenthash);
                    259:         #
                    260:         # Build up a list of sections
                    261:         my $section = $studenthash->{'section'};
1.60      matthew   262:         if (! defined($section) || $section =~/^\s*$/ || $section == -1) {
                    263:             $studenthash->{'section'} = 'none';
                    264:             $section = $studenthash->{'section'};
                    265:         }
1.59      matthew   266:         $Sections{$section}++;
                    267:         #
                    268:         # Only put in the list those students we are interested in
1.60      matthew   269:         foreach my $sect (@SelectedSections) {
1.68      matthew   270:             if ( (($sect eq 'all') || 
                    271:                   ($section eq $sect)) &&
1.94      matthew   272:                  (($studenthash->{'status'} eq $enrollment_status) || 
                    273:                   ($enrollment_status eq 'Any')) 
1.68      matthew   274:                  ){
1.60      matthew   275:                 push (@Students,$studenthash);
                    276:                 last;
                    277:             }
1.59      matthew   278:         }
                    279:     }
                    280:     #
                    281:     # Put the consolidated section data in the right place
1.70      matthew   282:     if ($ENV{'request.course.sec'} !~ /^\s*$/) {
1.69      matthew   283:         @Sections = ($ENV{'request.course.sec'});
                    284:     } else {
                    285:         @Sections = sort {$a cmp $b} keys(%Sections);
                    286:         unshift(@Sections,'all'); # Put 'all' at the front of the list
                    287:     }
1.59      matthew   288:     #
                    289:     # Sort the Students
                    290:     my $sortby = 'fullname';
1.60      matthew   291:     $sortby = $ENV{'form.sort'} if (exists($ENV{'form.sort'}));
                    292:     my @TmpStudents = sort { $a->{$sortby} cmp $b->{$sortby} ||
                    293:                              $a->{'fullname'} cmp $b->{'fullname'} } @Students;
                    294:     @Students = @TmpStudents;
1.59      matthew   295:     # 
                    296:     # Now deal with that current student thing....
1.72      matthew   297:     $curr_student = undef;
                    298:     if (exists($ENV{'form.SelectedStudent'})) {
1.59      matthew   299:         my ($current_uname,$current_dom) = 
1.72      matthew   300:             split(':',$ENV{'form.SelectedStudent'});
1.59      matthew   301:         my $i;
                    302:         for ($i = 0; $i<=$#Students; $i++) {
                    303:             next if (($Students[$i]->{'username'} ne $current_uname) || 
                    304:                      ($Students[$i]->{'domain'}   ne $current_dom));
1.60      matthew   305:             $curr_student = $Students[$i];
1.59      matthew   306:             last; # If we get here, we have our student.
                    307:         }
1.72      matthew   308:         if (defined($curr_student)) {
                    309:             if ($i == 0) {
                    310:                 $prev_student = undef;
                    311:             } else {
                    312:                 $prev_student = $Students[$i-1];
                    313:             }
                    314:             if ($i == $#Students) {
                    315:                 $next_student = undef;
                    316:             } else {
                    317:                 $next_student = $Students[$i+1];
                    318:             }
1.59      matthew   319:         }
                    320:     }
1.61      matthew   321:     #
                    322:     if (exists($ENV{'form.StudentData'})) {
                    323:         if (ref($ENV{'form.StudentData'}) eq 'ARRAY') {
                    324:             @SelectedStudentData = @{$ENV{'form.StudentData'}};
                    325:         } else {
                    326:             @SelectedStudentData = ($ENV{'form.StudentData'});
                    327:         }
                    328:     } else {
1.72      matthew   329:         @SelectedStudentData = ('username');
1.61      matthew   330:     }
                    331:     foreach (@SelectedStudentData) {
                    332:         if ($_ eq 'all') {
                    333:             @SelectedStudentData = ('all');
                    334:             last;
                    335:         }
                    336:     }
                    337:     #
                    338:     return;
                    339: }
                    340: 
1.71      matthew   341: 
                    342: #######################################################
                    343: #######################################################
                    344: 
                    345: =pod
                    346: 
                    347: =item get_students
                    348: 
                    349: Returns a list of the selected students
                    350: 
                    351: =cut
                    352: 
                    353: #######################################################
                    354: #######################################################
                    355: sub get_students {
                    356:     if (! @Students) {
                    357:         &PrepareClasslist()
                    358:     }
                    359:     return @Students;
                    360: }
                    361: 
1.61      matthew   362: #######################################################
                    363: #######################################################
                    364: 
                    365: =pod
                    366: 
                    367: =item &current_student()
                    368: 
                    369: Returns a pointer to a hash containing data about the currently
                    370: selected student.
                    371: 
                    372: =cut
                    373: 
                    374: #######################################################
                    375: #######################################################
                    376: sub current_student { 
1.72      matthew   377:     return $curr_student;
1.61      matthew   378: }
                    379: 
                    380: #######################################################
                    381: #######################################################
                    382: 
                    383: =pod
                    384: 
                    385: =item &previous_student()
                    386: 
                    387: Returns a pointer to a hash containing data about the student prior
                    388: in the list of students.  Or something.  
                    389: 
                    390: =cut
                    391: 
                    392: #######################################################
                    393: #######################################################
                    394: sub previous_student { 
1.72      matthew   395:     return $prev_student;
1.59      matthew   396: }
                    397: 
                    398: #######################################################
                    399: #######################################################
1.61      matthew   400: 
                    401: =pod
                    402: 
                    403: =item &next_student()
                    404: 
                    405: Returns a pointer to a hash containing data about the next student
                    406: to be viewed.
                    407: 
                    408: =cut
                    409: 
                    410: #######################################################
                    411: #######################################################
                    412: sub next_student { 
1.72      matthew   413:     return $next_student;
1.61      matthew   414: }
1.60      matthew   415: 
                    416: #######################################################
                    417: #######################################################
                    418: 
                    419: =pod
                    420: 
                    421: =item &clear_sequence_variables()
                    422: 
                    423: =cut
                    424: 
                    425: #######################################################
                    426: #######################################################
                    427: sub clear_sequence_variables {
                    428:     undef($top_map);
                    429:     undef(@Sequences);
                    430:     undef(@Assessments);
                    431: }
                    432: 
                    433: #######################################################
                    434: #######################################################
                    435: 
                    436: =pod
                    437: 
1.61      matthew   438: =item &SetSelectedMaps($elementname)
                    439: 
                    440: Sets the @SelectedMaps array from $ENV{'form.'.$elementname};
                    441: 
                    442: =cut
                    443: 
                    444: #######################################################
                    445: #######################################################
                    446: sub SetSelectedMaps {
                    447:     my $elementname = shift;
                    448:     if (exists($ENV{'form.'.$elementname})) {
                    449:         if (ref($ENV{'form.'.$elementname})) {
                    450:             @SelectedMaps = @{$ENV{'form.'.$elementname}};
                    451:         } else {
                    452:             @SelectedMaps = ($ENV{'form.'.$elementname});
                    453:         }
                    454:     } else {
                    455:         @SelectedMaps = ('all');
                    456:     }
1.64      matthew   457: }
                    458: 
                    459: 
                    460: #######################################################
                    461: #######################################################
                    462: 
                    463: =pod
                    464: 
                    465: =item &Sequences_with_Assess()
                    466: 
                    467: Returns an array containing the subset of @Sequences which contain
                    468: assessments.
                    469: 
                    470: =cut
                    471: 
                    472: #######################################################
                    473: #######################################################
                    474: sub Sequences_with_Assess {
1.102     matthew   475:     my ($mode) = @_;
                    476:     $mode = 'selected' if (! defined($mode));
1.64      matthew   477:     my @Sequences_to_Show;
1.102     matthew   478:     foreach my $sequence (@Sequences) {
                    479:         next if ($sequence->{'num_assess'} < 1);
                    480:         if ($mode eq 'all') {
1.64      matthew   481:             push (@Sequences_to_Show,$sequence);
1.102     matthew   482:         } elsif ($mode eq 'selected') {
                    483:             foreach my $map_symb (@SelectedMaps) {
                    484:                 if ($sequence->{'symb'} eq $map_symb || $map_symb eq 'all'){
                    485:                     push (@Sequences_to_Show,$sequence);
                    486:                     last; # Only put it in once
                    487:                 }
                    488:             }
1.64      matthew   489:         }
1.102     matthew   490: 
1.64      matthew   491:     }
                    492:     return @Sequences_to_Show;
1.61      matthew   493: }
                    494: 
                    495: #######################################################
                    496: #######################################################
                    497: 
                    498: =pod
                    499: 
1.60      matthew   500: =item &PrepareCourseData($r)
                    501: 
                    502: =cut
                    503: 
                    504: #######################################################
                    505: #######################################################
                    506: sub PrepareCourseData {
                    507:     my ($r) = @_;
                    508:     &clear_sequence_variables();
1.61      matthew   509:     my ($top,$sequences,$assessments) = 
                    510:         &Apache::loncoursedata::get_sequence_assessment_data();
1.60      matthew   511:     if (! defined($top) || ! ref($top)) {
                    512:         # There has been an error, better report it
                    513:         &Apache::lonnet::logthis('top is undefined');
                    514:         return;
                    515:     }
                    516:     $top_map = $top if (ref($top));
                    517:     @Sequences = @{$sequences} if (ref($sequences) eq 'ARRAY');
1.61      matthew   518:     @Assessments = @{$assessments} if (ref($assessments) eq 'ARRAY');
                    519:     return;
                    520: }
                    521: 
                    522: #######################################################
                    523: #######################################################
1.60      matthew   524: 
                    525: =pod
                    526: 
1.61      matthew   527: =item &log_sequence($sequence,$recursive,$padding)
                    528: 
                    529: Write data about the sequence to a logfile.  If $recursive is not
                    530: undef the data is written recursively.  $padding is used for recursive
                    531: calls.
                    532: 
                    533: =cut
                    534: 
                    535: #######################################################
                    536: #######################################################
                    537: sub log_sequence {
                    538:     my ($seq,$recursive,$padding) = @_;
                    539:     $padding = '' if (! defined($padding));
                    540:     if (ref($seq) ne 'HASH') {
                    541:         &Apache::lonnet::logthis('log_sequence passed bad sequnce');
                    542:         return;
                    543:     }
                    544:     &Apache::lonnet::logthis($padding.'sequence '.$seq->{'title'});
                    545:     while (my($key,$value) = each(%$seq)) {
                    546:         next if ($key eq 'contents');
                    547:         if (ref($value) eq 'ARRAY') {
                    548:             for (my $i=0;$i< scalar(@$value);$i++) {
                    549:                 &Apache::lonnet::logthis($padding.$key.'['.$i.']='.
                    550:                                          $value->[$i]);
                    551:             }
                    552:         } else {
                    553:             &Apache::lonnet::logthis($padding.$key.'='.$value);
                    554:         }
                    555:     }
                    556:     if (defined($recursive)) {
                    557:         &Apache::lonnet::logthis($padding.'-'x20);
                    558:         &Apache::lonnet::logthis($padding.'contains:');
                    559:         foreach my $item (@{$seq->{'contents'}}) {
                    560:             if ($item->{'type'} eq 'container') {
                    561:                 &log_sequence($item,$recursive,$padding.'    ');
                    562:             } else {
                    563:                 &Apache::lonnet::logthis($padding.'title = '.$item->{'title'});
                    564:                 while (my($key,$value) = each(%$item)) {
                    565:                     next if ($key eq 'title');
                    566:                     if (ref($value) eq 'ARRAY') {
                    567:                         for (my $i=0;$i< scalar(@$value);$i++) {
                    568:                             &Apache::lonnet::logthis($padding.$key.'['.$i.']='.
                    569:                                                      $value->[$i]);
                    570:                         }
                    571:                     } else {
                    572:                         &Apache::lonnet::logthis($padding.$key.'='.$value);
                    573:                     }
                    574:                 }
                    575:             }
1.60      matthew   576:         }
1.61      matthew   577:         &Apache::lonnet::logthis($padding.'end contents of '.$seq->{'title'});
                    578:         &Apache::lonnet::logthis($padding.'-'x20);
1.60      matthew   579:     }
1.61      matthew   580:     return;
                    581: }
                    582: 
                    583: ##############################################
                    584: ##############################################
                    585: 
                    586: =pod 
                    587: 
                    588: =item &StudentDataSelect($elementname,$status,$numvisible,$selected)
                    589: 
                    590: Returns html for a selection box allowing the user to choose one (or more) 
                    591: of the fields of student data available (fullname, username, id, section, etc)
                    592: 
                    593: =over 4
                    594: 
                    595: =item $elementname The name of the HTML form element
                    596: 
                    597: =item $status 'multiple' or 'single' selection box
                    598: 
                    599: =item $numvisible The number of options to be visible
                    600: 
                    601: =back
1.60      matthew   602: 
                    603: =cut
                    604: 
1.61      matthew   605: ##############################################
                    606: ##############################################
                    607: sub StudentDataSelect {
                    608:     my ($elementname,$status,$numvisible)=@_;
                    609:     if ($numvisible < 1) {
                    610:         return;
                    611:     }
                    612:     #
                    613:     # Build the form element
                    614:     my $Str = "\n";
                    615:     $Str .= '<select name="'.$elementname.'" ';
                    616:     if ($status ne 'single') {
                    617:         $Str .= 'multiple="true" ';
                    618:     }
                    619:     $Str .= 'size="'.$numvisible.'" >'."\n";
                    620:     #
                    621:     # Deal with 'all'
                    622:     $Str .= '    <option value="all" ';
                    623:     foreach (@SelectedStudentData) {
                    624:         if ($_ eq 'all') {
                    625:             $Str .= 'selected ';
                    626:             last;
                    627:         }
                    628:     }
                    629:     $Str .= ">all</option>\n";
                    630:     #
                    631:     # Loop through the student data fields
                    632:     foreach my $item (@StudentDataOrder) {
                    633:         $Str .= '    <option value="'.$item.'" ';
                    634:         foreach (@SelectedStudentData) {
                    635:             if ($item eq $_ ) {
                    636:                 $Str .= 'selected ';
                    637:                 last;
                    638:             }
                    639:         }
                    640:         $Str .= '>'.$item."</option>\n";
                    641:     }
                    642:     $Str .= "</select>\n";
                    643:     return $Str;
1.60      matthew   644: }
                    645: 
                    646: ##############################################
                    647: ##############################################
                    648: 
                    649: =pod 
                    650: 
1.61      matthew   651: =item &MapSelect($elementname,$status,$numvisible,$restriction) 
1.60      matthew   652: 
                    653: Returns html for a selection box allowing the user to choose one (or more) 
                    654: of the sequences in the course.  The values of the sequences are the symbs.
                    655: If the top sequence is selected, the value 'top' will result.
                    656: 
                    657: =over 4
                    658: 
                    659: =item $elementname The name of the HTML form element
                    660: 
                    661: =item $status 'multiple' or 'single' selection box
                    662: 
                    663: =item $numvisible The number of options to be visible
                    664: 
                    665: =item $restriction Code reference to subroutine which returns true or 
                    666: false.  The code must expect a reference to a sequence data structure.
                    667: 
                    668: =back
                    669: 
                    670: =cut
                    671: 
                    672: ##############################################
                    673: ##############################################
                    674: sub MapSelect {
1.61      matthew   675:     my ($elementname,$status,$numvisible,$restriction)=@_;
1.60      matthew   676:     if ($numvisible < 1) {
                    677:         return;
                    678:     }
                    679:     #
                    680:     # Set up array of selected items
1.61      matthew   681:     &SetSelectedMaps($elementname);
1.60      matthew   682:     #
                    683:     # Set up the restriction call
                    684:     if (! defined($restriction)) {
                    685:         $restriction = sub { 1; };
                    686:     }
                    687:     #
                    688:     # Build the form element
                    689:     my $Str = "\n";
                    690:     $Str .= '<select name="'.$elementname.'" ';
                    691:     if ($status ne 'single') {
                    692:         $Str .= 'multiple="true" ';
                    693:     }
                    694:     $Str .= 'size="'.$numvisible.'" >'."\n";
                    695:     #
1.61      matthew   696:     # Deal with 'all'
                    697:     foreach (@SelectedMaps) {
                    698:         if ($_ eq 'all') {
                    699:             @SelectedMaps = ('all');
                    700:             last;
                    701:         }
                    702:     }
                    703:     #
                    704:     # Put in option for 'all'
                    705:     $Str .= '    <option value="all" ';
                    706:     foreach (@SelectedMaps) {
                    707:         if ($_ eq 'all') {
                    708:             $Str .= 'selected ';
                    709:             last;
                    710:         }
                    711:     }
                    712:     $Str .= ">all</option>\n";
                    713:     #
1.60      matthew   714:     # Loop through the sequences
1.61      matthew   715:     foreach my $seq (@Sequences) {
                    716:         next if (! $restriction->($seq));
                    717:         $Str .= '    <option value="'.$seq->{'symb'}.'" ';
                    718:         foreach (@SelectedMaps) {
                    719:             if ($seq->{'symb'} eq $_) {
1.60      matthew   720:                 $Str .= 'selected ';
                    721:                 last;
                    722:             }
                    723:         }
1.61      matthew   724:         $Str .= '>'.$seq->{'title'}."</option>\n";
1.60      matthew   725:     }
                    726:     $Str .= "</select>\n";
                    727:     return $Str;
                    728: }
                    729: 
                    730: ##############################################
                    731: ##############################################
                    732: 
                    733: =pod 
                    734: 
                    735: =item &SectionSelect($elementname,$status,$numvisible) 
                    736: 
                    737: Returns html for a selection box allowing the user to choose one (or more) 
                    738: of the sections in the course.  
                    739: 
1.71      matthew   740: Uses the package variables @Sections and @SelectedSections
1.60      matthew   741: =over 4
                    742: 
                    743: =item $elementname The name of the HTML form element
                    744: 
                    745: =item $status 'multiple' or 'single' selection box
                    746: 
                    747: =item $numvisible The number of options to be visible
                    748: 
                    749: =back
                    750: 
                    751: =cut
                    752: 
                    753: ##############################################
                    754: ##############################################
                    755: sub SectionSelect {
                    756:     my ($elementname,$status,$numvisible)=@_;
                    757:     if ($numvisible < 1) {
                    758:         return;
                    759:     }
                    760:     #
1.71      matthew   761:     # Make sure we have the data we need to continue
                    762:     if (! @Sections) {
                    763:         &PrepareClasslist()
                    764:     }
                    765:     #
1.60      matthew   766:     # Build the form element
                    767:     my $Str = "\n";
                    768:     $Str .= '<select name="'.$elementname.'" ';
                    769:     if ($status ne 'single') {
                    770:         $Str .= 'multiple="true" ';
                    771:     }
                    772:     $Str .= 'size="'.$numvisible.'" >'."\n";
                    773:     #
                    774:     # Loop through the sequences
                    775:     foreach my $s (@Sections) {
                    776:         $Str .= '    <option value="'.$s.'" ';
                    777:         foreach (@SelectedSections) {
1.61      matthew   778:             if ($s eq $_) {
1.60      matthew   779:                 $Str .= 'selected ';
                    780:                 last;
                    781:             }
                    782:         }
                    783:         $Str .= '>'.$s."</option>\n";
                    784:     }
                    785:     $Str .= "</select>\n";
                    786:     return $Str;
1.80      matthew   787: }
                    788: 
1.61      matthew   789: ##################################################
                    790: ##################################################
1.60      matthew   791: sub DisplayClasslist {
                    792:     my ($r)=@_;
1.107     matthew   793:     &Apache::lonhtmlcommon::add_breadcrumb
                    794:         ({text=>'Select One Student'});
1.60      matthew   795:     #
1.105     matthew   796:     # Output some of the standard interface components
                    797:     my $Str;
1.107     matthew   798:     $Str .= &Apache::lonhtmlcommon::breadcrumbs(undef,'Select One Student');
1.105     matthew   799:     $Str .= '<p><table cellspacing="5">'."\n";
                    800:     $Str .= '<tr>';
                    801:     $Str .= '<th align="center"><b>'.&mt('Sections').'</b></th>';
                    802:     $Str .= '<th align="center"><b>'.&mt('Enrollment Status').'</b></th>';
                    803:     $Str .= '</tr>'.$/;
                    804:     $Str .= '<tr>';
                    805:     $Str .= '<td>'.
                    806:         &Apache::lonstatistics::SectionSelect('Section','multiple',5).
                    807:         '</td>';
                    808:     $Str .= '<td>'.
                    809:         &Apache::lonhtmlcommon::StatusOptions(undef,undef,5).
                    810:         '</td>';
                    811:     
                    812:     $Str .= '</tr>'.$/;
                    813:     $Str .= '</table></p>';
                    814:     $Str .= '<input type="submit" name="selectstudent" value="'.
                    815:         &mt('Update Display').'" />';
                    816:     $r->print($Str);
                    817:     $r->rflush();
                    818:     #
                    819:     my @Fields = ('fullname','username','domain','id','section','status');
1.60      matthew   820:     #
1.105     matthew   821:     $Str = '';
1.78      matthew   822:     if (! @Students) {
                    823:         if ($SelectedSections[0] eq 'all') { 
                    824:             if (lc($ENV{'form.Status'}) eq 'any') {
1.106     matthew   825:                 $Str .= '<h2>'.
                    826:                     &mt('There are no students in the course.').
                    827:                     '</h2>';
1.78      matthew   828:             } elsif (lc($ENV{'form.Status'}) eq 'active') {
1.106     matthew   829:                 $Str .= '<h2>'.
                    830:                 &mt('There are no currently enrolled students in the course.').
                    831:                     '</h2>';
1.78      matthew   832:             } elsif (lc($ENV{'form.Status'}) eq 'expired') {
1.106     matthew   833:                 $Str .= '<h2>'.
                    834:                     &mt('There are no previously enrolled students in the course.').
                    835:                         '</h2>';
1.78      matthew   836:             }
                    837:         } else { 
                    838:             my $sections;
                    839:             if (lc($ENV{'form.Status'}) eq 'any') {
1.106     matthew   840:                 $Str .= '<h2>'.
                    841:                     &mt('There are no students in the selected sections.').
                    842:                     '</h2>';
1.78      matthew   843:             } elsif (lc($ENV{'form.Status'}) eq 'active') {
1.106     matthew   844:                 $Str .= '<h2>'.
                    845:                     &mt('There are no currently enrolled students in the selected sections.').
                    846:                     '</h2>';
1.78      matthew   847:             } elsif (lc($ENV{'form.Status'}) eq 'expired') {
1.106     matthew   848:                 $Str .= '<h2>'.
                    849:                     &mt('There are no previously enrolled students in the selected sections.').
                    850:                     '</h2>';
1.78      matthew   851:             }
                    852:         }
                    853:         $Str.= '<a href="/adm/statistics?reportSelected=student_assessment">'.
1.106     matthew   854:             &mt('Click here to return to the chart').'</a>';
1.78      matthew   855:         $r->print($Str);
                    856:         $r->rflush();
                    857:         return;
                    858:     }
                    859: 
1.76      matthew   860:     # "Click" is asinine but it is probably not my place to change the world.
1.78      matthew   861:     $Str .= '<h2>Click on a students name or username to view their chart</h2>';
1.60      matthew   862:     $Str .= '<table border="0"><tr><td bgcolor="#777777">'."\n";
                    863:     $Str .= '<table border="0" cellpadding="3"><tr bgcolor="#e6ffff">'."\n";
                    864:     foreach my $field (@Fields) {
1.101     matthew   865:         $Str .= '<th><a href="/adm/statistics?'.
                    866:             'reportSelected=student_assessment&'.
                    867:             'selectstudent=1&'.
1.106     matthew   868:             'sort='.$field.'">'.&mt($field).
1.60      matthew   869:             '</a></th>';
                    870:     }
                    871:     $Str .= '</tr>'."\n";
                    872:     #
                    873:     my $alternate = 0;
1.65      matthew   874:     foreach my $student (@Students) { # @Students is a package variable
1.60      matthew   875:         my $sname = $student->{'username'}.':'.$student->{'domain'};
                    876:         if($alternate) {
                    877:             $Str .= '<tr bgcolor="#ffffe6">';
                    878:         } else {
                    879:             $Str .= '<tr bgcolor="#ffffc6">';
                    880:         }
                    881:         $alternate = ($alternate + 1) % 2;
                    882:         #
                    883:         foreach my $field (@Fields) {
                    884:             $Str .= '<td>';
1.78      matthew   885:             if ($field eq 'fullname' || $field eq 'username') {
1.60      matthew   886:                 $Str .= '<a href="/adm/statistics?reportSelected=';
1.65      matthew   887:                 $Str .= &Apache::lonnet::escape('student_assessment');
1.72      matthew   888:                 $Str .= '&sort='.&Apache::lonnet::escape($ENV{'form.sort'});
                    889:                 $Str .= '&SelectedStudent=';
1.61      matthew   890:                 $Str .= &Apache::lonnet::escape($sname).'">';
1.60      matthew   891:                 $Str .= $student->{$field}.'&nbsp';
                    892:                 $Str .= '</a>';
1.106     matthew   893:             } elsif ($field eq 'status') {
                    894:                 $Str .= &mt($student->{$field});
1.60      matthew   895:             } else {
                    896:                 $Str .= $student->{$field};
                    897:             }
                    898:             $Str .= '</td>';
                    899:         }
                    900:         $Str .= "</tr>\n";
                    901:     }
                    902:     $Str .= '</table></td></tr></table>'."\n";
                    903:     #
                    904:     $r->print($Str);
                    905:     $r->rflush();
                    906:     #
                    907:     return;
                    908: }
                    909: 
1.65      matthew   910: ##############################################
                    911: ##############################################
1.33      stredwic  912: sub CreateMainMenu {
1.65      matthew   913:     #
1.85      matthew   914:     # Define menu data
                    915:     my @reports = ({ internal_name => 'problem_statistics',
                    916:                      name => &mt('Overall Problem Statistics'),
                    917:                      short_description => 
                    918:     &mt('Student performance statistics on all problems.'),
                    919:                  },
                    920:                    { internal_name => 'problem_analysis',
                    921:                      name => &mt('Detailed Problem Analysis'),
                    922:                      short_description => 
                    923:     &mt('Detailed statistics and graphs of student performance on problems.'),
                    924:                  },
1.89      matthew   925:                    { internal_name => 'submissiontime_analysis',
1.94      matthew   926:                      name => &mt('Submission Time Plots'),
1.89      matthew   927:                      short_description => 
                    928:     &mt('Display and analysis of submission times on assessments.'),
                    929:                  },
1.97      matthew   930:                    { internal_name => 'student_submission_reports',
                    931:                      name => &mt('Student Submission Reports'),
                    932:                      short_description => 
1.111     matthew   933:     &mt('Prepare reports of student submissions.'),
1.97      matthew   934:                  },
1.104     matthew   935:                    { internal_name => 'survey_reports',
                    936:                      name => &mt('Survey Reports'),
                    937:                      short_description => 
                    938:     &mt('Prepare reports on survey results.'),
                    939:                  },
1.94      matthew   940:                    { internal_name => 'correct_problems_plot',
                    941:                      name => &mt('Correct Problems Plot'),
                    942:                      short_description => 
                    943:     &mt('Display a histogram of student performance in the course.'),
                    944:                  },
1.88      matthew   945: #                   { internal_name => 'student_assessment',
                    946: #                     name => &mt('Problem Status Chart'),
                    947: #                     short_description => 
                    948: #    &mt('Brief view of each students performance in course.'),
                    949: #                 },
1.85      matthew   950:                    # 'percentage'  => 'Correct-problems Plot',
                    951:                    # 'activitylog' => 'Activity Log',
                    952:                    );
1.65      matthew   953:     #
1.85      matthew   954:     # Create the menu
                    955:     my $Str;
1.98      matthew   956:     $Str .= '<h2>'.&mt('Please select a report to generate').'</h2>';
1.85      matthew   957:     foreach my $reportdata (@reports) {
1.87      matthew   958:         $Str .='    <h3><a href="/adm/statistics?reportSelected='.
1.85      matthew   959:             $reportdata->{'internal_name'}.'" >'.
1.87      matthew   960:             $reportdata->{'name'}."</a></h3>\n";
                    961:         $Str .= '    '.('&nbsp;'x8).$reportdata->{'short_description'}.
                    962:             "\n";
1.85      matthew   963:     }
                    964:     $Str .="</dl>\n";
1.65      matthew   965:     #
1.33      stredwic  966:     return $Str;
                    967: }
                    968: 
1.65      matthew   969: ##############################################
                    970: ##############################################
1.1       albertel  971: sub handler {
1.31      minaeibi  972:     my $r=shift;
1.65      matthew   973:     my $c = $r->connection();
                    974:     #
                    975:     # Check for overloading
1.51      www       976:     my $loaderror=&Apache::lonnet::overloaderror($r);
                    977:     if ($loaderror) { return $loaderror; }
                    978:     $loaderror=
                    979:        &Apache::lonnet::overloaderror($r,
                    980:          $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
                    981:     if ($loaderror) { return $loaderror; }
1.65      matthew   982:     #
                    983:     # Check for access
1.69      matthew   984:     if (! &Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
1.27      stredwic  985:         $ENV{'user.error.msg'}=
1.69      matthew   986:             $r->uri.":vgr:0:0:Cannot view grades for complete course";
                    987:         if (! &Apache::lonnet::allowed('vgr',
                    988:                       $ENV{'request.course.id'}.'/'.$ENV{'request.course.sec'})) {
                    989:             $ENV{'user.error.msg'}=
                    990:                 $r->uri.":vgr:0:0:Cannot view grades with given role";
                    991:             return HTTP_NOT_ACCEPTABLE;
                    992:         }
1.27      stredwic  993:     }
1.65      matthew   994:     #
                    995:     # Send the header
1.92      www       996:     &Apache::loncommon::no_cache($r);
                    997:     &Apache::loncommon::content_type($r,'text/html');
1.27      stredwic  998:     $r->send_http_header;
1.92      www       999:     if ($r->header_only) { return OK; }
1.65      matthew  1000:     #
                   1001:     # Extract form elements from query string
1.60      matthew  1002:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.65      matthew  1003:                                             ['sort','reportSelected',
1.72      matthew  1004:                                              'SelectedStudent']);
1.65      matthew  1005:     #
                   1006:     # Give the LON-CAPA page header
1.109     matthew  1007:     my $style = <<ENDSTYLE;
                   1008: <style type="text/css">
                   1009:     ul.sub_studentans { list-style-type: none }
                   1010:     ul.sub_correctans { list-style-type: none }
1.110     matthew  1011:     tr.even           { background-color: \#CCCCCC }
                   1012:     td.essay          { border: 1px solid gray; }
1.109     matthew  1013: </style>
                   1014: ENDSTYLE
1.96      matthew  1015:     $r->print('<html><head><title>'.
                   1016:               &mt('Course Statistics and Charts').
1.109     matthew  1017:               '</title>'.$style.
                   1018:               "</head>\n".
1.98      matthew  1019:               &Apache::loncommon::bodytag('Course Statistics and Charts'));
1.65      matthew  1020:     $r->rflush();
1.85      matthew  1021:     # 
                   1022:     # Either print out a menu for them or send them to a report
1.98      matthew  1023:     &Apache::lonhtmlcommon::clear_breadcrumbs();
                   1024:     &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/statistics',
1.100     matthew  1025:                                             title=>'Statistics',
                   1026:                                             text =>'Statistics',
1.98      matthew  1027:                                             faq=>139,
                   1028:                                             bug=>'Statistics and Charts'});
1.85      matthew  1029:     if (! exists($ENV{'form.reportSelected'}) || 
                   1030:         $ENV{'form.reportSelected'} eq '') {
1.98      matthew  1031:         $r->print(&Apache::lonhtmlcommon::breadcrumbs
1.99      matthew  1032:                   (undef,&mt('Statistics Main Page')).
1.98      matthew  1033:                   &CreateMainMenu());
1.85      matthew  1034:     } else {
1.65      matthew  1035:     #
1.85      matthew  1036:         if (! &Apache::lonmysql::verify_sql_connection()) {
                   1037:             my $serveradmin = $r->dir_config('lonAdmEMail');
                   1038:             $r->print('<h2><font color="Red">'.
                   1039:                       &mt('Unable to connect to database!').
                   1040:                       '</font></h2>');
                   1041:             $r->print('<p>'.
                   1042:                       &mt('Please notify the server administrator ').
                   1043:                       '<b>'.$serveradmin.'</b></p>');
                   1044:             $r->print('<p>'.
                   1045:                       &mt('Course Statistics and Charts cannot be '.
                   1046:                           'retrieved until the database is restarted.  '.
                   1047:                           'Your data is intact but cannot be displayed '.
                   1048:                           'at this time.').'</p>');
                   1049:             $r->print('</body></html>');
                   1050:             return;
                   1051:         }
                   1052:         #
                   1053:         # Clean out the caches
                   1054:         if (exists($ENV{'form.ClearCache'})) {
                   1055:             &Apache::loncoursedata::delete_caches($ENV{'requres.course.id'});
                   1056:         }
                   1057:         #
                   1058:         # Begin form output
                   1059:         $r->print('<form name="Statistics" ');
                   1060:         $r->print('method="post" action="/adm/statistics">');
                   1061:         $r->rflush();
                   1062:         #
                   1063:         my $GoToPage = $ENV{'form.reportSelected'};
1.90      matthew  1064:         #
                   1065:         # Set up the statistics and chart environment
                   1066:         &PrepareCourseData($r);
                   1067:         #
1.85      matthew  1068:         $r->print('<input type="hidden" name="reportSelected" value="'.
                   1069:                   $GoToPage.'">');
                   1070:         if($GoToPage eq 'activitylog') {
1.65      matthew  1071: #        &Apache::lonproblemstatistics::Activity();
1.85      matthew  1072:         } elsif($GoToPage eq 'problem_statistics') {
1.98      matthew  1073:             &Apache::lonhtmlcommon::add_breadcrumb
                   1074:                 ({href=>'/adm/statistics?reportselected=problem_statistics',
1.100     matthew  1075:                   text=>'Overall Problem Statistics'});
1.85      matthew  1076:             &Apache::lonproblemstatistics::BuildProblemStatisticsPage($r,$c);
                   1077:         } elsif($GoToPage eq 'problem_analysis') {
1.98      matthew  1078:             &Apache::lonhtmlcommon::add_breadcrumb
                   1079:                 ({href=>'/adm/statistics?reportselected=problem_analysis',
1.100     matthew  1080:                   text=>'Detailed Problem Analysis'});
1.85      matthew  1081:             &Apache::lonproblemanalysis::BuildProblemAnalysisPage($r,$c);
1.89      matthew  1082:         } elsif($GoToPage eq 'submissiontime_analysis') {
1.98      matthew  1083:             &Apache::lonhtmlcommon::add_breadcrumb
                   1084:                 ({href=>
                   1085:                       '/adm/statistics?reportselected=submissiontime_analysis',
1.100     matthew  1086:                       text=>'Submission Time Plots'});
1.89      matthew  1087:             &Apache::lonsubmissiontimeanalysis::BuildSubmissionTimePage($r,$c);
1.97      matthew  1088:         } elsif($GoToPage eq 'student_submission_reports') {
1.98      matthew  1089:             &Apache::lonhtmlcommon::add_breadcrumb
                   1090:                 ({href=>
                   1091:                   '/adm/statistics?reportselected=student_submission_reports',
1.100     matthew  1092:                   text=>'Student Submission Reports'});
1.97      matthew  1093:             &Apache::lonstudentsubmissions::BuildStudentSubmissionsPage($r,$c);
1.104     matthew  1094:         } elsif($GoToPage eq 'survey_reports') {
                   1095:             &Apache::lonhtmlcommon::add_breadcrumb
                   1096:                 ({href=>
                   1097:                   '/adm/statistics?reportselected=survey_reports',
                   1098:                   text=>'Survey Reports'});
                   1099:             &Apache::lonsurveyreports::BuildSurveyReportsPage($r,$c);
1.94      matthew  1100:         } elsif($GoToPage eq 'correct_problems_plot') {
1.98      matthew  1101:             &Apache::lonhtmlcommon::add_breadcrumb
                   1102:                 ({href=>'/adm/statistics?reportselected=correct_problems_plot',
1.100     matthew  1103:                   text=>'Correct Problems Plot'});
1.94      matthew  1104:             &Apache::loncorrectproblemplot::BuildCorrectProblemsPage($r,$c);
1.85      matthew  1105:         } elsif($GoToPage eq 'student_assessment') {
1.98      matthew  1106:             &Apache::lonhtmlcommon::clear_breadcrumbs();
                   1107:             &Apache::lonhtmlcommon::add_breadcrumb
                   1108:                 ({href=>'/adm/statistics?reportselected=student_assessment',
1.100     matthew  1109:                   text=>'Chart'});
1.85      matthew  1110:             &Apache::lonstudentassessment::BuildStudentAssessmentPage($r,$c);
                   1111:         }
                   1112:         #
                   1113:         $r->print("</form>\n");
1.65      matthew  1114:     }
                   1115:     $r->print("</body>\n</html>\n");
                   1116:     $r->rflush();
                   1117:     #
1.27      stredwic 1118:     return OK;
1.1       albertel 1119: }
1.65      matthew  1120: 
1.1       albertel 1121: 1;
1.59      matthew  1122: 
1.65      matthew  1123: #######################################################
                   1124: #######################################################
                   1125: 
1.59      matthew  1126: =pod
                   1127: 
                   1128: =back
                   1129: 
                   1130: =cut
1.65      matthew  1131: 
                   1132: #######################################################
                   1133: #######################################################
1.59      matthew  1134: 
1.1       albertel 1135: __END__
1.31      minaeibi 1136: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>