File:  [LON-CAPA] / loncom / interface / lonstatistics.pm
Revision 1.148.2.7: download - view: text, annotated - select for diffs
Sun Dec 5 17:27:30 2010 UTC (13 years, 7 months ago) by raeburn
Branches: GCI_3
Diff to branchpoint 1.148: preferred, unified
- Customization for GCI_3.
  - Suport for multiple Concept Inventories.

    1: # The LearningOnline Network with CAPA
    2: #
    3: # $Id: lonstatistics.pm,v 1.148.2.7 2010/12/05 17:27:30 raeburn Exp $
    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
   28: #
   29: ###
   30: 
   31: 
   32: 
   33: package Apache::lonstatistics;
   34: 
   35: use strict;
   36: use Apache::Constants qw(:common :http);
   37: use vars qw(
   38:     @FullClasslist 
   39:     @Students
   40:     @Sections
   41:     @Groups 
   42:     %StudentData
   43:     @StudentDataOrder
   44:     @SelectedStudentData
   45:     $enrollment_status);
   46: 
   47: use Apache::lonnet;
   48: use Apache::lonhomework;
   49: use Apache::loncommon;
   50: use Apache::loncoursedata;
   51: use Apache::lonhtmlcommon;
   52: use Apache::lonmysql;
   53: use Apache::lonlocal;
   54: use Apache::longroup;
   55: use Time::HiRes;
   56: #
   57: # Statistics Packages
   58: use Apache::lonproblemanalysis();
   59: use Apache::lonsubmissiontimeanalysis();
   60: use Apache::loncorrectproblemplot();
   61: use Apache::lonproblemstatistics();
   62: use Apache::lonstudentassessment();
   63: use Apache::lonpercentage;
   64: use Apache::lonstudentsubmissions();
   65: use Apache::lonsurveyreports();
   66: use Apache::longradinganalysis();
   67: use LONCAPA;
   68: 
   69: #
   70: # Classlist variables
   71: #
   72: my $curr_student;
   73: my $prev_student;
   74: my $next_student;
   75: 
   76: 
   77: sub clear_classlist_variables {
   78:     undef(@FullClasslist);
   79:     undef(@Students);
   80:     undef(@Sections);
   81:     undef(@Groups);
   82:     undef(%StudentData);
   83:     undef(@SelectedStudentData);
   84:     undef($curr_student);
   85:     undef($prev_student);
   86:     undef($next_student);
   87: }
   88: 
   89: 
   90: sub PrepareClasslist {
   91:     my %Sections;
   92:     &clear_classlist_variables();
   93:     #
   94:     # Retrieve the classlist
   95:     my $cid  = $env{'request.course.id'};
   96:     my $cdom = $env{'course.'.$cid.'.domain'};
   97:     my $cnum = $env{'course.'.$cid.'.num'};
   98:     my ($classlist,$field_names) = &Apache::loncoursedata::get_classlist($cdom,
   99: 									$cnum);
  100:     my @selected_sections = &get_selected_sections();
  101:     my @selected_groups = &get_selected_groups();
  102:     #
  103:     # Deal with instructors with restricted section access
  104:     if ($env{'request.course.sec'} !~ /^\s*$/) {
  105:         @selected_sections = ($env{'request.course.sec'});
  106:     }
  107:     #
  108:     # Set up %StudentData
  109:     @StudentDataOrder = qw/fullname username domain id section status groups comments/;
  110:     foreach my $field (@StudentDataOrder) {
  111:         $StudentData{$field}->{'title'} = &mt($field);
  112:         $StudentData{$field}->{'base_width'} = length(&mt($field));
  113:         $StudentData{$field}->{'width'} = 
  114:                                $StudentData{$field}->{'base_width'};
  115:     }
  116:     #
  117:     # get the status requested
  118:     $enrollment_status = 'Active';
  119:     $enrollment_status = $env{'form.Status'} if (exists($env{'form.Status'}));
  120:     #
  121:     # Get groupmembership
  122:     my ($classgroups,$studentgroups);
  123:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
  124:     if (%curr_groups) {
  125:         ($classgroups,$studentgroups) = 
  126: 	    &Apache::loncoursedata::get_group_memberships($classlist,
  127:                                                           $field_names,
  128: 							  $cdom,$cnum);
  129:     }
  130:     my $now = time;
  131: 
  132:     # Process the classlist
  133:     while (my ($student,$student_data) = each (%$classlist)) {
  134:         my $studenthash = ();
  135:         for (my $i=0; $i< scalar(@$field_names);$i++) {
  136:             my $field = $field_names->[$i];
  137:             # Store the data
  138:             $studenthash->{$field}=$student_data->[$i];
  139:             # Keep track of the width of the fields
  140:             next if (! exists($StudentData{$field}));
  141:             my $length = length($student_data->[$i]);
  142:             if ($StudentData{$field}->{'width'} < $length) {
  143:                 $StudentData{$field}->{'width'} = $length; 
  144:             }
  145:         }
  146:         my @studentsgroups = &Apache::loncoursedata::get_students_groups
  147:                                                    ($student,$enrollment_status,
  148:                                                     $classgroups);
  149:         if (@studentsgroups) {
  150:             $studenthash->{'groups'} = join(', ',@studentsgroups);
  151:             $studenthash->{'groupref'} = \@studentsgroups;
  152:         } else {
  153:             $studenthash->{'groups'} = 'none';
  154:             $studenthash->{'groupref'} = []; 
  155:         }
  156:         push (@FullClasslist,$studenthash);
  157:         #
  158:         # Build up a list of sections
  159:         my $section = $studenthash->{'section'};
  160:         if (! defined($section) || $section =~/^\s*$/ || $section == -1) {
  161:             $studenthash->{'section'} = 'none';
  162:             $section = $studenthash->{'section'};
  163:         }
  164:         $Sections{$section}++;
  165:         #
  166:         # Only put in the list those students we are interested in
  167:         foreach my $sect (@selected_sections) {
  168:             if ( (($sect eq 'all') || 
  169:                   ($section eq $sect)) &&
  170:                  (($studenthash->{'status'} eq $enrollment_status) || 
  171:                   ($enrollment_status eq 'Any')) 
  172:                  ){
  173:                 my $groupcheck = 0;
  174:                 if (grep(/^all$/,@selected_groups)) {
  175:                     push(@Students,$studenthash);
  176:                     last;
  177:                 } elsif (grep(/^none$/,@selected_groups)) {
  178:                     if ($studenthash->{'groups'} eq 'none') {
  179:                         push(@Students,$studenthash);
  180:                         last;
  181:                     }     
  182:                 } else {
  183:                     foreach my $group (@selected_groups) {
  184:                         if (grep(/^$group$/,@studentsgroups)) {
  185:                             push(@Students,$studenthash);
  186:                             $groupcheck = 1;
  187:                             last;
  188:                         }
  189:                     }
  190:                     if ($groupcheck) {
  191:                         last;
  192:                     }
  193:                 }
  194:             }
  195:         }
  196:     }
  197:     #
  198:     # Put the consolidated section data in the right place
  199:     if ($env{'request.course.sec'} !~ /^\s*$/) {
  200:         @Sections = ($env{'request.course.sec'});
  201:     } else {
  202:         @Sections = sort {
  203: 	    if ($a == $a && $b == $b ) { return $a <=> $b; }
  204: 	    return $a cmp $b;
  205: 	} keys(%Sections);
  206: 
  207:         unshift(@Sections,'all'); # Put 'all' at the front of the list
  208:     }
  209:     # Sort the groups
  210:     @Groups = sort {$a cmp $b} keys(%{$studentgroups});
  211:     unshift(@Groups,'all'); # Put 'all' at the front of the list
  212: 
  213:     #
  214:     # Sort the Students
  215:     my $sortby = 'fullname';
  216:     $sortby = $env{'form.sort'} if (exists($env{'form.sort'}));
  217:     my @TmpStudents = sort { lc($a->{$sortby}) cmp lc($b->{$sortby}) ||
  218:                              lc($a->{'fullname'}) cmp lc($b->{'fullname'}) ||
  219: 			     lc($a->{'username'}) cmp lc($b->{'username'}) } @Students;
  220:     @Students = @TmpStudents;
  221:     # 
  222:     # Now deal with that current student thing....
  223:     $curr_student = undef;
  224:     if (exists($env{'form.SelectedStudent'})) {
  225:         my ($current_uname,$current_dom) = 
  226:             split(':',$env{'form.SelectedStudent'});
  227:         my $i;
  228:         for ($i = 0; $i<=$#Students; $i++) {
  229:             next if (($Students[$i]->{'username'} ne $current_uname) || 
  230:                      ($Students[$i]->{'domain'}   ne $current_dom));
  231:             $curr_student = $Students[$i];
  232:             last; # If we get here, we have our student.
  233:         }
  234:         if (defined($curr_student)) {
  235:             if ($i == 0) {
  236:                 $prev_student = undef;
  237:             } else {
  238:                 $prev_student = $Students[$i-1];
  239:             }
  240:             if ($i == $#Students) {
  241:                 $next_student = undef;
  242:             } else {
  243:                 $next_student = $Students[$i+1];
  244:             }
  245:         }
  246:     }
  247:     #
  248:     if (exists($env{'form.StudentData'})) {
  249: 	@SelectedStudentData = 
  250: 	    &Apache::loncommon::get_env_multiple('form.StudentData');
  251:     } else {
  252:         @SelectedStudentData = ('username');
  253:     }
  254:     foreach (@SelectedStudentData) {
  255:         if ($_ eq 'all') {
  256:             @SelectedStudentData = ('all');
  257:             last;
  258:         }
  259:     }
  260:     #
  261:     return;
  262: }
  263: 
  264: 
  265: sub get_selected_sections {
  266:     my @selected_sections = 
  267: 	&Apache::loncommon::get_env_multiple('form.Section');
  268:     @selected_sections = ('all') if (! @selected_sections);
  269:     foreach (@selected_sections) {
  270:         if ($_ eq 'all') {
  271:             @selected_sections = ('all');
  272:         }
  273:     }
  274:     #
  275:     # Deal with instructors with restricted section access
  276:     if ($env{'request.course.sec'} !~ /^\s*$/) {
  277:         @selected_sections = ($env{'request.course.sec'});
  278:     }
  279:     return @selected_sections;
  280: }
  281: 
  282: 
  283: sub get_selected_groups {
  284:     my @selected_groups =
  285:         &Apache::loncommon::get_env_multiple('form.Group');
  286:     @selected_groups = ('all') if (! @selected_groups);
  287:     foreach my $grp (@selected_groups) {
  288:         if ($grp eq 'all') {
  289:             @selected_groups = ('all');
  290:             last;
  291:         }
  292:     }
  293:     return @selected_groups;
  294: }
  295:                                                                                     
  296: 
  297: 
  298: sub section_and_enrollment_description {
  299:     my ($mode) = @_;
  300:     if (! defined($mode)) { $mode = 'localized'; }
  301:     my @sections = &Apache::lonstatistics::get_selected_sections();
  302:     my @groups = &Apache::lonstatistics::get_selected_groups();
  303:     my $description;
  304:     if ($mode eq 'localized') {
  305:         $description = &mt('Unable to determine section, groups and access status');
  306:     } elsif ($mode eq 'plaintext') {
  307:         $description = 'Unable to determine section, groups and access status';
  308:     } else {
  309:         $description = 'Bad parameter passed to lonstatistics::section_and_enrollment_description';
  310:         &Apache::lonnet::logthis($description);
  311:     }
  312:     $description = &section_or_group_text($mode,'section',@sections).
  313: 	' '.&section_or_group_text($mode,'group',@groups);
  314:     if ($mode eq 'localized') {
  315:         $description .= ' '.&mt($env{'form.Status'}.' access status.');
  316:     } elsif ($mode eq 'plaintext') {
  317:         $description .= ' '.$env{'form.Status'}.' access status.';
  318:     }
  319:     return $description;
  320: }
  321: 
  322: 
  323: 
  324: 
  325: sub section_or_group_text {
  326:     my ($mode,$type,@items) = @_;
  327:     my $text;
  328:     my %phrases = ();
  329:     %{$phrases{'section'}} = (
  330:                               single => 'Section',
  331:                               all => 'All sections',
  332:                               plural => 'Sections',
  333:                              );
  334:     %{$phrases{'group'}} = (
  335:                               single => 'Group',
  336:                               all => 'All groups',
  337:                               plural => 'Groups',
  338:                              );
  339:     if (scalar(@items) == 1 && $items[0] ne 'all') {
  340:         if ($mode eq 'localized') {
  341:             $text = &mt($phrases{$type}{single}.' [_1].',$items[0]);
  342:         } elsif ($mode eq 'plaintext') {
  343:             $text = $phrases{$type}{single}.' '.$items[0].'.';
  344: 
  345:         }
  346:     } elsif (scalar(@items) && $items[0] eq 'all') {
  347:         if ($mode eq 'localized') {
  348:             $text = &mt($phrases{$type}{all}.'.');
  349:         } elsif ($mode eq 'plaintext') {
  350:             $text = $phrases{$type}{all}.'.';
  351:         }
  352:     } elsif (scalar(@items)) {
  353:         my $lastitem = pop(@items);
  354:         if ($mode eq 'localized') {
  355:             $text = &mt($phrases{$type}{plural}.' [_1] and [_2].',
  356:                         join(', ',@items),$lastitem);
  357:         } elsif ($mode eq 'plaintext') {
  358:             $text = $phrases{$type}{plural}.' '.join(', ',@items).' and '.
  359:                     $lastitem.'.';
  360:         }
  361:     }
  362:     return $text;
  363: }
  364: 
  365: 
  366: sub get_students {
  367:     if (! @Students) {
  368:         &PrepareClasslist()
  369:     }
  370:     return @Students;
  371: }
  372: 
  373: 
  374: 
  375: sub current_student { 
  376:     return $curr_student;
  377: }
  378: 
  379: 
  380: 
  381: sub previous_student { 
  382:     return $prev_student;
  383: }
  384: 
  385: 
  386: 
  387: sub next_student { 
  388:     return $next_student;
  389: }
  390: 
  391: 
  392: 
  393: sub StudentDataSelect {
  394:     my ($elementname,$status,$numvisible)=@_;
  395:     if ($numvisible < 1) {
  396:         return;
  397:     }
  398:     #
  399:     # Build the form element
  400:     my $Str = "\n";
  401:     $Str .= '<select name="'.$elementname.'" ';
  402:     if ($status ne 'single') {
  403:         $Str .= 'multiple="multiple" ';
  404:     }
  405:     $Str .= 'size="'.$numvisible.'" >'."\n";
  406:     #
  407:     # Deal with 'all'
  408:     $Str .= '    <option value="all" ';
  409:     foreach (@SelectedStudentData) {
  410:         if ($_ eq 'all') {
  411:             $Str .= 'selected ';
  412:             last;
  413:         }
  414:     }
  415:     $Str .= ">all</option>\n";
  416:     #
  417:     # Loop through the student data fields
  418:     foreach my $item (@StudentDataOrder) {
  419:         $Str .= '    <option value="'.$item.'" ';
  420:         foreach (@SelectedStudentData) {
  421:             if ($item eq $_ ) {
  422:                 $Str .= 'selected ';
  423:                 last;
  424:             }
  425:         }
  426:         $Str .= '>'.$item."</option>\n";
  427:     }
  428:     $Str .= "</select>\n";
  429:     return $Str;
  430: }
  431: 
  432: 
  433: 
  434: sub get_selected_maps {
  435:     my ($elementname) = @_;
  436:     my @selected_maps = 
  437: 	&Apache::loncommon::get_env_multiple('form.'.$elementname);
  438:     @selected_maps = ('all') if (! @selected_maps);
  439:     foreach my $map (@selected_maps) {
  440:         if ($map eq 'all') {
  441:             @selected_maps = ('all');
  442:             last;
  443:         }
  444:     }
  445:     return @selected_maps;
  446: }
  447: 
  448: 
  449: 
  450: 
  451: sub selected_sequences_with_assessments {
  452:     my ($mode) = @_;
  453:     $mode = 'selected' if (! defined($mode));
  454:     my $navmap = Apache::lonnavmaps::navmap->new();
  455:     if (!defined($navmap)) {
  456:         return ('Can not open Coursemap');
  457:     }
  458:     #
  459:     my $mapurl;
  460:     if (&Apache::loncommon::needs_gci_custom()) {
  461:         my $cid = $env{'request.course.id'};
  462:         if ($cid) {
  463:             my $cdom = $env{'course.'.$cid.'.domain'};
  464:             if ($cdom =~ /^\w+citest$/) {
  465:                 my $sequence = &Apache::loncommon::get_citest_map($cdom);
  466:                 my $cnum = $env{'course.'.$cid.'.num'};  
  467:                 if ($sequence) {
  468:                     $mapurl = '/uploaded/'.$cdom.'/'.$cnum.'/'.$sequence;
  469:                 }
  470:             }
  471:         }
  472:     }
  473:     my @sequences = $navmap->retrieveResources($mapurl,
  474:                                                sub { shift->is_map(); },1,0,1);
  475:     unless (&Apache::loncommon::needs_gci_custom()) {
  476:         my $toplevelseq = $navmap->getById('0.0');
  477:         if (!grep(/^\Q$toplevelseq\E$/,@sequences)) {
  478:             unshift(@sequences,$toplevelseq);
  479:         }
  480:     }
  481: 
  482:     my @sequences_with_assessments;
  483:     foreach my $sequence (@sequences) {
  484: 	if ($navmap->hasResource($sequence,sub { shift->is_problem(); },0,1)){
  485:             push(@sequences_with_assessments,$sequence);
  486:         }
  487:     }
  488:     #
  489:     my @sequences_to_show;
  490:     foreach my $sequence (@sequences_with_assessments) {
  491:         if ($mode eq 'all') {
  492:             push (@sequences_to_show,$sequence);
  493:         } elsif ($mode eq 'selected') {
  494:             foreach my $map_symb (&get_selected_maps('Maps')) {
  495:                 if ($sequence->symb eq $map_symb || $map_symb eq 'all'){
  496:                     push (@sequences_to_show,$sequence);
  497:                     last; # Only put it in once
  498:                 }
  499:             }
  500:         }
  501: 
  502:     }
  503:     return $navmap,@sequences_to_show;
  504: }
  505: 
  506: 
  507: sub map_select {
  508:     my ($elementname,$status,$numvisible)=@_;
  509:     if ($numvisible < 1) {
  510:         return;
  511:     }
  512:     #
  513:     # Set up array of selected items
  514:     my @selected_maps = &get_selected_maps($elementname);
  515:     #
  516:     # Build the form element
  517:     my $form = "\n";
  518:     $form .= '<select name="'.$elementname.'" ';
  519:     if ($status ne 'single') {
  520:         $form .= 'multiple="multiple" ';
  521:     }
  522:     $form .= 'size="'.$numvisible.'" >'."\n";
  523:     unless (&Apache::loncommon::needs_gci_custom()) {
  524:         #
  525:         # Put in option for 'all'
  526:         $form .= '    <option value="all" ';
  527:         if ($selected_maps[0] eq 'all') {
  528:             $form .= 'selected ';
  529:         }
  530:         $form .= ">all</option>\n";
  531:     }
  532:     #
  533:     # Loop through the sequences
  534:     my @sequences = &selected_sequences_with_assessments('all');
  535:     my $navmap;
  536:     if (!ref($sequences[0])) {
  537:         return $sequences[0];
  538:     } else {
  539:         $navmap = shift(@sequences);
  540:     }
  541:     foreach my $seq (@sequences){
  542:         $form .= '    <option value="'.$seq->symb.'" ';
  543:         if ((&Apache::loncommon::needs_gci_custom()) && (@selected_maps == 1)) {
  544:             $form .= 'selected ';
  545:         } else {
  546:             foreach (@selected_maps) {
  547:                 if ($seq->symb eq $_) {
  548:                     $form .= 'selected ';
  549:                     last;
  550:                 }
  551:             }
  552:         }
  553:         $form .= '>'.$seq->compTitle."</option>\n";
  554:     }
  555:     $form .= "</select>\n";
  556:     return $form;
  557: }
  558: 
  559: 
  560: sub SectionSelect {
  561:     my ($elementname,$status,$numvisible)=@_;
  562:     if ($numvisible < 1) {
  563:         return;
  564:     }
  565:     #
  566:     # Make sure we have the data we need to continue
  567:     if (! @Sections) {
  568:         &PrepareClasslist()
  569:     }
  570:     #
  571:     # Build the form element
  572:     my $Str = "\n";
  573:     $Str .= '<select name="'.$elementname.'" ';
  574:     if ($status ne 'single') {
  575:         $Str .= 'multiple="multiple" ';
  576:     }
  577:     $Str .= 'size="'.$numvisible.'" >'."\n";
  578:     #
  579:     # Loop through the sequences
  580:     foreach my $s (@Sections) {
  581:         $Str .= '    <option value="'.$s.'" ';
  582:         foreach (&get_selected_sections()) {
  583:             if ($s eq $_) {
  584:                 $Str .= 'selected ';
  585:                 last;
  586:             }
  587:         }
  588:         $Str .= '>'.$s."</option>\n";
  589:     }
  590:     $Str .= "</select>\n";
  591:     return $Str;
  592: }
  593: 
  594: 
  595: sub GroupSelect {
  596:     my ($elementname,$status,$numvisible)=@_;
  597:     if ($numvisible < 1) {
  598:         return;
  599:     }
  600:     #
  601:     # Make sure we have the data we need to continue
  602:     if (! @Groups) {
  603:         &PrepareClasslist();
  604:     }
  605:     #
  606:     # Build the form element
  607:     my $Str = "\n";
  608:     $Str .= '<select name="'.$elementname.'" ';
  609:     if ($status ne 'single') {
  610:         $Str .= 'multiple="multiple" ';
  611:     }
  612:     $Str .= 'size="'.$numvisible.'" >'."\n";
  613:     #
  614:     # Loop through the groups
  615:     foreach my $s (@Groups) {
  616:         $Str .= '    <option value="'.$s.'" ';
  617:         foreach my $group (&get_selected_groups()) {
  618:             if ($s eq $group) {
  619:                 $Str .= 'selected ';
  620:                 last;
  621:             }
  622:         }
  623:         $Str .= '>'.$s."</option>\n";
  624:     }
  625:     $Str .= "</select>\n";
  626: }
  627: 
  628: 
  629: 
  630: 
  631: sub DisplayClasslist {
  632:     my ($r)=@_;
  633:     &Apache::lonhtmlcommon::add_breadcrumb
  634:         ({text=>'Select One Student'});
  635:     #
  636:     # Output some of the standard interface components
  637:     my $Str;
  638:     $Str .= &Apache::lonhtmlcommon::breadcrumbs('Select One Student');
  639:     $Str .= '<p><table cellspacing="5">'."\n";
  640:     $Str .= '<tr>';
  641:     $Str .= '<th align="center"><b>'.&mt('Sections').'</b></th>';
  642:     $Str .= '<th align="center"><b>'.&mt('Groups').'</b></th>';
  643:     $Str .= '<th align="center"><b>'.&mt('Access Status').'</b></th>';
  644:     $Str .= '</tr>'.$/;
  645:     $Str .= '<tr>';
  646:     $Str .= '<td>'.
  647:         &Apache::lonstatistics::SectionSelect('Section','multiple',5).
  648:         '</td>';
  649:     $Str .=  '<td>'.
  650:         &Apache::lonstatistics::GroupSelect('Group','multiple',5).
  651:         '</td>';
  652:     $Str .= '<td>'.
  653:         &Apache::lonhtmlcommon::StatusOptions(undef,undef,5).
  654:         '</td>';
  655:     
  656:     $Str .= '</tr>'.$/;
  657:     $Str .= '</table></p>';
  658:     $Str .= '<input type="submit" name="selectstudent" value="'.
  659:         &mt('Update Display').'" />';
  660:     $r->print($Str);
  661:     $r->rflush();
  662:     #
  663:     my @Fields = ('fullname','username','domain','id','section','status','groups');
  664:     #
  665:     $Str = '';
  666:     my @selected_sections = &get_selected_sections();
  667:     if (! @Students) {
  668:         if ($selected_sections[0] eq 'all') { 
  669:             if (lc($env{'form.Status'}) eq 'active') {
  670:                 $Str .= '<p class="LC_info">'.
  671:                 &mt('There are no currently enrolled students in the course.').
  672:                     '</p>';
  673:             } elsif (lc($env{'form.Status'}) eq 'expired') {
  674:                 $Str .= '<p class="LC_info">'.
  675:                     &mt('There are no previously enrolled students in the course.').
  676:                         '</p>';
  677:             } elsif (lc($env{'form.Status'}) eq 'future') {
  678:                 $Str .= '<p class="LC_info">'.
  679:                     &mt('There are no students with future access in the course.').
  680:                         '</p>';
  681:             } else { # 'any' and any others
  682:                $Str .= '<p class="LC_info">'.
  683:                     &mt('There are no students in the course.').
  684:                     '</p>';
  685:             }
  686:         } else { 
  687:             if (lc($env{'form.Status'}) eq 'active') {
  688:                 $Str .= '<p class="LC_info">'.
  689:                     &mt('There are no currently enrolled students in the selected sections.').
  690:                     '</p>';
  691:             } elsif (lc($env{'form.Status'}) eq 'expired') {
  692:                 $Str .= '<p class="LC_info">'.
  693:                     &mt('There are no previously enrolled students in the selected sections.').
  694:                     '</p>';
  695:             } elsif (lc($env{'form.Status'}) eq 'future') {
  696:                 $Str .= '<p class="LC_info">'.
  697:                     &mt('There are no students with future access in the selected sections.').
  698:                         '</p>';
  699:             } else { # 'any' and any others
  700:                 $Str .= '<p class="LC_info">'.
  701:                     &mt('There are no students in the selected sections.').
  702:                     '</p>';
  703:             }
  704:         }
  705:         $Str.= '<p>'
  706:               .'<a href="/adm/statistics?reportSelected=student_assessment">'
  707:               .&mt('Return to the chart').'</a>'
  708:               .'</p>';
  709:         $r->print($Str);
  710:         $r->rflush();
  711:         return;
  712:     }
  713: 
  714:     $Str .= '<h2>'.&mt('Select One Student').'</h2>'
  715:            .'<p>'.&mt("Click on a student's name or username to view their chart").'</p>'
  716:            .&Apache::loncommon::start_data_table()
  717:            .&Apache::loncommon::start_data_table_header_row();
  718:     foreach my $field (@Fields) {
  719:         $Str .= '<th><a href="/adm/statistics?'.
  720:             'reportSelected=student_assessment&'.
  721:             'selectstudent=1&'.
  722:             'sort='.$field.'">'.&mt($field).
  723:             '</a></th>';
  724:     }
  725:     $Str .= &Apache::loncommon::end_data_table_header_row();
  726:     #
  727:     foreach my $student (@Students) { # @Students is a package variable
  728:         my $sname = $student->{'username'}.':'.$student->{'domain'};
  729:         $Str .= &Apache::loncommon::start_data_table_row();
  730:         #
  731:         foreach my $field (@Fields) {
  732:             $Str .= '<td>';
  733:             if ($field eq 'fullname' || $field eq 'username') {
  734:                 $Str .= '<a href="/adm/statistics?reportSelected=';
  735:                 $Str .= &escape('student_assessment');
  736:                 $Str .= '&sort='.&escape($env{'form.sort'});
  737:                 $Str .= '&SelectedStudent=';
  738:                 $Str .= &escape($sname).'">';
  739:                 $Str .= $student->{$field}.'&nbsp;';
  740:                 $Str .= '</a>';
  741:             } elsif ($field eq 'status') {
  742:                 $Str .= &mt($student->{$field});
  743:             } else {
  744:                 $Str .= $student->{$field};
  745:             }
  746:             $Str .= '</td>';
  747:         }
  748:         $Str .= &Apache::loncommon::end_data_table_row();
  749:     }
  750:     $Str .= &Apache::loncommon::end_data_table();
  751:     #
  752:     $r->print($Str);
  753:     $r->rflush();
  754:     #
  755:     return;
  756: }
  757: 
  758: 
  759: 
  760: sub CreateMainMenu {
  761:     #
  762:     # Define menu data
  763:     my @reports = (
  764: 	    {categorytitle => 'Statistics and Analyses',
  765:          items => [
  766:             {url => '/adm/statistics?reportSelected=problem_statistics',
  767: 			 permission => 'F',
  768:              icon => 'document-open.png',
  769:              linktext => ('Overall Problem Statistics'),
  770:              linktitle => ('Student performance statistics on all problems.')},
  771:        
  772:             {url => '/adm/statistics?reportSelected=problem_analysis',
  773: 			 permission => 'F',
  774:              icon => 'edit-find.png',
  775:              linktext => ('Detailed Problem Analysis'),
  776:              linktitle => ('Detailed statistics and graphs of student performance on problems.')},
  777:          ]},
  778:         {categorytitle => 'Plots',
  779:          items => [
  780:             {url => '/adm/statistics?reportSelected=submissiontime_analysis',
  781: 			 permission => 'F',
  782:              icon => 'subtimpl.png',
  783:              linktext => ('Submission Time Plots'),
  784:              linktitle => ('Display and analysis of submission times on assessments.')},
  785:       
  786:             {url => '/adm/statistics?reportSelected=correct_problems_plot',
  787: 			 permission => 'F',
  788:              icon => 'coprplot.png',
  789:              linktext => ('Correct Problems Plot'),
  790:              linktitle => ('Display a histogram of student performance in the course.')},
  791:          ]});
  792:     if (&Apache::loncommon::needs_gci_custom()) {
  793:         push(@reports,
  794:         {categorytitle => 'Reports',
  795:          items => [
  796:             {url => '/adm/statistics?reportSelected=student_submission_reports',
  797:                          permission => 'F',
  798:              icon => 'edit-copy.png',
  799:              linktext => ('Student Submission Reports'),
  800:              linktitle => ('Prepare reports of student submissions.')},
  801:          ]});
  802:     } else {
  803:         push(@reports,
  804:         {categorytitle => 'Reports',
  805:          items => [
  806:             {url => '/adm/statistics?reportSelected=student_submission_reports',
  807: 			 permission => 'F',
  808:              icon => 'edit-copy.png',
  809:              linktext => ('Student Submission Reports'),
  810:              linktitle => ('Prepare reports of student submissions.')},
  811:                     
  812:             {url => '/adm/statistics?reportSelected=survey_reports',
  813: 			 permission => 'F',
  814:              icon => 'docs.png',
  815: 			 linktext => ('Survey Reports'),
  816:              linktitle => ('Prepare reports on survey results.')},
  817:          ]});
  818:     }
  819:     
  820: return &Apache::lonhtmlcommon::generate_menu(@reports);
  821:  
  822: }
  823: 
  824: sub handler {
  825:     my $r=shift;
  826:     my $c = $r->connection();
  827:     #
  828:     # Check for overloading
  829:     my $loaderror=&Apache::lonnet::overloaderror($r);
  830:     if ($loaderror) { return $loaderror; }
  831:     $loaderror=
  832:        &Apache::lonnet::overloaderror($r,
  833:          $env{'course.'.$env{'request.course.id'}.'.home'});
  834:     if ($loaderror) { return $loaderror; }
  835:     #
  836:     # Check for access
  837:     if (! &Apache::lonnet::allowed('vgr',$env{'request.course.id'})) {
  838:         $env{'user.error.msg'}=
  839:             $r->uri.":vgr:0:0:Cannot view grades for complete course";
  840:         if (! &Apache::lonnet::allowed('vgr',
  841:                       $env{'request.course.id'}.'/'.$env{'request.course.sec'})) {
  842:             $env{'user.error.msg'}=
  843:                 $r->uri.":vgr:0:0:Cannot view grades with given role";
  844:             return HTTP_NOT_ACCEPTABLE;
  845:         }
  846:     }
  847:     #
  848:     # Send the header
  849:     &Apache::loncommon::no_cache($r);
  850:     &Apache::loncommon::content_type($r,'text/html');
  851:     $r->send_http_header;
  852:     if ($r->header_only) { return OK; }
  853:     my $gcicustom = &Apache::loncommon::needs_gci_custom();
  854:     if ($gcicustom) {
  855:         my $now = time;
  856:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  857:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
  858:         my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
  859:         my $duedate = $courseopt->{$env{'request.course.id'}.'.0.duedate'};
  860:         if ((!$duedate) || ($duedate > $now)) {
  861:             my $brcrum = [{href=> '/adm/statistics',
  862:                            text=> 'Statistics',}];
  863:             my $args = {bread_crumbs           => $brcrum,
  864:                         bread_crumbs_component => 'Statistics Main Page'};
  865:             $r->print(&Apache::loncommon::start_page('Course Statistics',undef,$args));
  866:             $r->print('<h3>'.&mt('Display of statistics').'</h3>');
  867:             if ($duedate > $now) { 
  868:                 $r->print('<p>'.&mt('Aggregate test performance data will be available after the Concept Test end date: [_1].',
  869:                          &Apache::lonlocal::locallocaltime($duedate)).'</p>');
  870:             } else {
  871:                 $r->print('<p>'.
  872:                           &mt('Aggregate test performance data unavailable without definition of an end date for the Concept Test.').'</p>');
  873:             }
  874:             $r->print(&Apache::loncommon::end_page());
  875:             return OK;
  876:         }
  877:     }
  878: 
  879:     #
  880:     # Extract form elements from query string
  881:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  882:                                             ['sort','reportSelected',
  883:                                              'SelectedStudent']);
  884:     #
  885:     # Give the LON-CAPA page header
  886:     my $style = <<ENDSTYLE;
  887: <style type="text/css">
  888:     ul.sub_studentans { list-style-type: none }
  889:     ul.sub_correctans { list-style-type: none }
  890:     tr.even           { background-color: \#CCCCCC }
  891:     td.essay          { border: 1px solid gray; }
  892: </style>
  893: ENDSTYLE
  894:       
  895:     $r->print(&Apache::loncommon::start_page('Course Statistics and Charts',
  896: 					     $style));
  897:     $r->rflush();
  898:     # 
  899:     # Either print out a menu for them or send them to a report
  900:     &Apache::lonhtmlcommon::clear_breadcrumbs();
  901:     &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/statistics',
  902:                                             title=>'Statistics',
  903:                                             text =>'Statistics',
  904:                                             faq=>139,
  905:                                             bug=>'Statistics and Charts'});
  906:     if (! exists($env{'form.reportSelected'}) || 
  907:         $env{'form.reportSelected'} eq '') {
  908:         $r->print(&Apache::lonhtmlcommon::breadcrumbs('Statistics Main Page').
  909:                   &CreateMainMenu());
  910:     } else {
  911:     #
  912:         if (! &Apache::lonmysql::verify_sql_connection()) {
  913:             my $serveradmin = $r->dir_config('lonAdmEMail');
  914:             $r->print('<h2 class="LC_error">'.
  915:                       &mt('Unable to connect to database!').
  916:                       '</h2>');
  917:             $r->print('<p>'
  918:                      .&mt('Please notify the server administrator [_1]',
  919:                          ,'<b>'.$serveradmin.'</b>')
  920:                      .'</p>');
  921:             $r->print('<p>'.
  922:                       &mt('Course Statistics and Charts cannot be '.
  923:                           'retrieved until the database is restarted. '.
  924:                           'Your data is intact but cannot be displayed '.
  925:                           'at this time.').'</p>');
  926:             $r->print(&Apache::loncommon::end_page());
  927:             return;
  928:         }
  929:         #
  930:         # Clean out the caches
  931:         if (exists($env{'form.ClearCache'})) {
  932:             &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
  933:         }
  934:         #
  935:         # Begin form output
  936:         $r->print('<form name="Statistics" ');
  937:         $r->print('method="post" action="/adm/statistics">');
  938:         $r->rflush();
  939:         #
  940:         my $GoToPage = $env{'form.reportSelected'};
  941:         #
  942:         $r->print('<input type="hidden" name="reportSelected" value="'.
  943:                   $GoToPage.'">');
  944:         if($GoToPage eq 'activitylog') {
  945: #        &Apache::lonproblemstatistics::Activity();
  946:         } elsif($GoToPage eq 'problem_statistics') {
  947:             &Apache::lonhtmlcommon::add_breadcrumb
  948:                 ({href=>'/adm/statistics?reportselected=problem_statistics',
  949:                   text=>'Overall Problem Statistics'});
  950:             &Apache::lonproblemstatistics::BuildProblemStatisticsPage($r,$c);
  951:         } elsif($GoToPage eq 'problem_analysis') {
  952:             &Apache::lonhtmlcommon::add_breadcrumb
  953:                 ({href=>'/adm/statistics?reportselected=problem_analysis',
  954:                   text=>'Detailed Problem Analysis'});
  955:             &Apache::lonproblemanalysis::BuildProblemAnalysisPage($r,$c);
  956:         } elsif($GoToPage eq 'submissiontime_analysis') {
  957:             &Apache::lonhtmlcommon::add_breadcrumb
  958:                 ({href=>
  959:                       '/adm/statistics?reportselected=submissiontime_analysis',
  960:                       text=>'Submission Time Plots'});
  961:             &Apache::lonsubmissiontimeanalysis::BuildSubmissionTimePage($r,$c);
  962:         } elsif($GoToPage eq 'student_submission_reports') {
  963:             &Apache::lonhtmlcommon::add_breadcrumb
  964:             ({href=>
  965:               '/adm/statistics?reportselected=student_submission_reports',
  966:               text=>'Student Submission Reports'});
  967:             &Apache::lonstudentsubmissions::BuildStudentSubmissionsPage($r,$c);
  968:         } elsif($GoToPage eq 'survey_reports') {
  969:             &Apache::lonhtmlcommon::add_breadcrumb
  970:                 ({href=>
  971:                   '/adm/statistics?reportselected=survey_reports',
  972:                   text=>'Survey Reports'});
  973:             &Apache::lonsurveyreports::BuildSurveyReportsPage($r,$c);
  974:         } elsif($GoToPage eq 'correct_problems_plot') {
  975:             &Apache::lonhtmlcommon::add_breadcrumb
  976:                 ({href=>'/adm/statistics?reportselected=correct_problems_plot',
  977:                   text=>'Correct Problems Plot'});
  978:             &Apache::loncorrectproblemplot::BuildCorrectProblemsPage($r,$c);
  979:         } elsif($GoToPage eq 'student_assessment') {
  980:             &Apache::lonhtmlcommon::clear_breadcrumbs();
  981:             &Apache::lonhtmlcommon::add_breadcrumb
  982:                 ({href=>'/adm/statistics?reportselected=student_assessment',
  983:                   text=>'Chart'});
  984:             if ($gcicustom) {
  985:                 $r->print(&mt('Only aggregate performance data are available for Concept Tests.'));  
  986:             } else {
  987:                 &Apache::lonstudentassessment::BuildStudentAssessmentPage($r,$c);
  988:             }
  989:         } elsif($GoToPage eq 'grading_analysis') {
  990:             &Apache::lonhtmlcommon::add_breadcrumb
  991:                 ({href=>'/adm/statistics?reportselected=grading_anaylsis',
  992:                   text=>'Grading Analysis'});
  993:             &Apache::longradinganalysis::build_grading_analysis_page($r,$c);
  994: 	}
  995:         #
  996:         $r->print("</form>\n");
  997:     }
  998:     $r->print(&Apache::loncommon::end_page());
  999:     $r->rflush();
 1000:     #
 1001:     return OK;
 1002: }
 1003: 
 1004: 1;
 1005: 
 1006: __END__
 1007: 
 1008: =pod
 1009: 
 1010: =head1 NAME
 1011: 
 1012: lonstatistics
 1013: 
 1014: =head1 SYNOPSIS
 1015: 
 1016: Main handler for statistics and chart.
 1017: 
 1018: This is part of the LearningOnline Network with CAPA project
 1019: described at http://www.lon-capa.org.
 1020: 
 1021: 
 1022: =head1 PACKAGE VARIABLES
 1023: 
 1024: =over
 1025: 
 1026: =item @FullClasslist The full classlist
 1027: 
 1028: =item @Students The students we are concerned with for this invocation
 1029: 
 1030: =item @Sections The sections available in this class
 1031: 
 1032: =item @Groups The groups available in the class
 1033: 
 1034: =item $curr_student The student currently being examined
 1035: 
 1036: =item $prev_student The student previous in the classlist
 1037: 
 1038: =item $next_student The student next in the classlist
 1039: 
 1040: =back
 1041: 
 1042: =head1 SUBROUTINES
 1043: 
 1044: =over
 1045: 
 1046: =item &clear_classlist_variables()
 1047: 
 1048: undef the following package variables:
 1049: 
 1050: =over 4
 1051: 
 1052: =item * @FullClasslist
 1053: 
 1054: =item * @Students
 1055: 
 1056: =item * @Sections
 1057: 
 1058: =item * @Groups
 1059: 
 1060: =item * %StudentData
 1061: 
 1062: =item * @StudentDataOrder
 1063: 
 1064: =item * @SelectedStudentData
 1065: 
 1066: =item * $curr_student
 1067: 
 1068: =item * $prev_student
 1069: 
 1070: =item * $next_student
 1071: 
 1072: =back
 1073: 
 1074: =item &PrepareClasslist()
 1075: 
 1076: Build up the classlist information.  The classlist information is kept in
 1077: the following package variables:
 1078: 
 1079: =over 4 
 1080: 
 1081: =item * @FullClasslist
 1082: 
 1083: =item * @Students
 1084: 
 1085: =item * @Sections
 1086: 
 1087: =item * @Groups 
 1088: 
 1089: =item * %StudentData
 1090: 
 1091: =item * @SelectedStudentData
 1092: 
 1093: =item * $curr_student
 1094: 
 1095: =item * $prev_student
 1096: 
 1097: =item * $next_student
 1098: 
 1099: =back
 1100: 
 1101: $curr_student, $prev_student, and $next_student may not be defined, depending
 1102: upon the calling context.
 1103: 
 1104: =item get_selected_sections()
 1105: 
 1106: Returns an array of the selected sections
 1107: 
 1108: =item get_selected_groups()
 1109:                                                                                     
 1110: Returns an array of the selected groups
 1111: 
 1112: =item &section_and_enrollment_description()
 1113: 
 1114: Returns a string describing the currently selected section(s), group(s) and 
 1115: access status.  
 1116: 
 1117: Inputs: mode = 'plaintext' or 'localized'  (defaults to 'localized')
 1118:     'plaintext' is used for example in Excel spreadsheets.
 1119: Returns: scalar description string.
 1120: 
 1121: =item section_or_group_text()
 1122: 
 1123: =item get_students()
 1124: 
 1125: Returns a list of the selected students
 1126: 
 1127: =item &current_student()
 1128: 
 1129: Returns a pointer to a hash containing data about the currently
 1130: selected student.
 1131: 
 1132: =item &previous_student()
 1133: 
 1134: Returns a pointer to a hash containing data about the student prior
 1135: in the list of students.  Or something. 
 1136: 
 1137: =item &next_student()
 1138: 
 1139: Returns a pointer to a hash containing data about the next student
 1140: to be viewed. 
 1141: 
 1142: =item &StudentDataSelect($elementname,$status,$numvisible,$selected)
 1143: 
 1144: Returns html for a selection box allowing the user to choose one (or more) 
 1145: of the fields of student data available (fullname, username, id, section, etc)
 1146: 
 1147: =over 4
 1148: 
 1149: =item * $elementname The name of the HTML form element
 1150: 
 1151: =item * $status 'multiple' or 'single' selection box
 1152: 
 1153: =item * $numvisible The number of options to be visible
 1154: 
 1155: =back
 1156: 
 1157: =item &get_selected_maps($elementname)
 1158: 
 1159: Input: Name of the <select> form element used to specify the maps.
 1160: 
 1161: Returns: Array of symbs of selected maps or the description 'all'.
 1162:    If form.$elementname does not exist, 'all' is returned.
 1163: 
 1164: =item &selected_sequences_with_assessments()
 1165: 
 1166: Retrieve the sequences which were selected by the user to show.  
 1167: 
 1168: Input: $mode: scalar.  Either 'selected' or 'all'.  If not specified,
 1169:     'selected' is used.
 1170: 
 1171: Returns: an array containing a navmap object and navmap resources, 
 1172:     or an array containing a scalar with an error message.
 1173: 
 1174: =item &map_select($elementname,$status,$numvisible,$restriction) 
 1175: 
 1176: Returns html for a selection box allowing the user to choose one (or more) 
 1177: of the sequences in the course.  The values of the sequences are the symbs.
 1178: If the top sequence is selected, the value 'top' will result.
 1179: 
 1180: =over 4
 1181: 
 1182: =item * $elementname The name of the HTML form element
 1183: 
 1184: =item * $status 'multiple' or 'single' selection box
 1185: 
 1186: =item * $numvisible The number of options to be visible
 1187: 
 1188: =back
 1189: 
 1190: =item &SectionSelect($elementname,$status,$numvisible) 
 1191: 
 1192: Returns html for a selection box allowing the user to choose one (or more) 
 1193: of the sections in the course.  
 1194: 
 1195: Uses the package variables @Sections
 1196: 
 1197: =over 4
 1198: 
 1199: =item * $elementname The name of the HTML form element
 1200: 
 1201: =item * $status 'multiple' or 'single' selection box
 1202: 
 1203: =item * $numvisible The number of options to be visible
 1204: 
 1205: =back
 1206: 
 1207: =item &GroupSelect($elementname,$status,$numvisible)
 1208:                                                                                     
 1209: Returns html for a selection box allowing the user to choose one (or more)
 1210: of the groups in the course.
 1211:                                                                                     
 1212: Uses the package variables @Groups
 1213: 
 1214: =over 4
 1215:                                                                                     
 1216: =item * $elementname The name of the HTML form element
 1217:                                                                                     
 1218: =item * $status 'multiple' or 'single' selection box
 1219:                                                                                     
 1220: =item * $numvisible The number of options to be visible
 1221:                                                                                     
 1222: =back
 1223: 
 1224: =item CreateMainMenu()
 1225: 
 1226: =back
 1227: 
 1228: =cut
 1229: 

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