Annotation of loncom/interface/lonquickgrades.pm, revision 1.49.6.5.2.1

1.1       bowersj2    1: # The LearningOnline Network with CAPA
                      2: # Quick Student Grades Display
                      3: #
1.49.6.5.2.1! raeburn     4: # $Id: lonquickgrades.pm,v 1.49.6.5 2018/12/01 16:38:06 raeburn Exp $
1.1       bowersj2    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
                     28: 
                     29: package Apache::lonquickgrades;
                     30: 
                     31: use strict;
1.49.6.1  raeburn    32: use Apache::Constants qw(:common :http REDIRECT);
1.5       bowersj2   33: use POSIX;
1.25      www        34: use Apache::loncommon;
                     35: use Apache::lonlocal;
1.36      albertel   36: use Apache::lonnet;
1.38      bowersj2   37: use Apache::grades;
1.49.6.3  raeburn    38: use Apache::lonuserstate;
1.1       bowersj2   39: 
                     40: sub handler {
                     41:     my $r = shift;
1.5       bowersj2   42:     return real_handler($r);
                     43: }
                     44: 
                     45: sub real_handler {
                     46:     my $r = shift;
1.1       bowersj2   47: 
                     48:     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
                     49: 
                     50:     # Handle header-only request
1.40      albertel   51:     if ($env{'browser.mathml'}) {
                     52: 	&Apache::loncommon::content_type($r,'text/xml');
                     53:     } else {
                     54: 	&Apache::loncommon::content_type($r,'text/html');
                     55:     }
1.1       bowersj2   56:     if ($r->header_only) {
1.40      albertel   57: 	$r->send_http_header;
1.1       bowersj2   58:         return OK;
                     59:     }
                     60: 
1.49.6.4  raeburn    61:     my $showPoints =
                     62:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard';
                     63: 
                     64:     my $reinitresult;
                     65: 
1.49.6.2  raeburn    66:     unless (&Apache::lonnet::allowed('mgr')) {
                     67:         # Check for critical messages and redirect if present.
1.49.6.5.2.1! raeburn    68:         my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'grades');
1.49.6.2  raeburn    69:         if ($redirect) {
                     70:             &Apache::loncommon::content_type($r,'text/html');
                     71:             $r->header_out(Location => $url);
                     72:             return REDIRECT;
                     73:         }
                     74: 
                     75:         # Check if course needs to be re-initialized
                     76:         my $loncaparev = $r->dir_config('lonVersion');
1.49.6.4  raeburn    77:         ($reinitresult,my @reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
1.49.6.2  raeburn    78: 
1.49.6.4  raeburn    79:         if ($reinitresult eq 'switch') {
1.49.6.2  raeburn    80:             &Apache::loncommon::content_type($r,'text/html');
                     81:             $r->send_http_header;
                     82:             $r->print(&Apache::loncommon::check_release_result(@reinit));
                     83:             return OK;
1.49.6.4  raeburn    84:         } elsif ($reinitresult eq 'update') {
                     85:             my $cid = $env{'request.course.id'};
                     86:             my $cnum = $env{'course.'.$cid.'.num'};
                     87:             my $cdom = $env{'course.'.$cid.'.domain'};
                     88:             &Apache::loncommon::content_type($r,'text/html');
                     89:             $r->send_http_header;
                     90:             &startpage($r,$showPoints);
                     91:             my $preamble = '<div id="LC_update_'.$cid.'" class="LC_info">'.
                     92:                            '<br />'.
                     93:                            &mt('Your course session is being updated because of recent changes by course personnel.').
                     94:                            ' '.&mt('Please be patient.').'<br /></div>'.
                     95:                            '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.49.6.5  raeburn    96:             my %prog_state = &Apache::lonhtmlcommon::Create_PrgWin($r,undef,$preamble);
1.49.6.4  raeburn    97:             &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Updating course'));
                     98:             $r->rflush();
1.49.6.2  raeburn    99:             my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
1.49.6.4  raeburn   100:             &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Finished'));
                    101:             &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
                    102:             my $closure = <<ENDCLOSE;
                    103: <script type="text/javascript">
                    104: // <![CDATA[
                    105: \$("#LC_update_$cid").hide('slow');
                    106: // ]]>
                    107: </script>
                    108: ENDCLOSE
1.49.6.2  raeburn   109:             if ($ferr) {
1.49.6.4  raeburn   110:                 $r->print($closure.&Apache::loncommon::end_page());
1.49.6.2  raeburn   111:                 my $requrl = $r->uri;
                    112:                 $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
                    113:                 $env{'user.reinit'} = 1;
                    114:                 return HTTP_NOT_ACCEPTABLE;
1.49.6.4  raeburn   115:             } else {
                    116:                $r->print($closure);
1.49.6.2  raeburn   117:             }
                    118:         }
                    119:     }
                    120: 
1.49.6.4  raeburn   121:     unless ($reinitresult eq 'update') {
                    122:         # Send header, don't cache this page
                    123:         &Apache::loncommon::no_cache($r);
                    124:         $r->send_http_header;
                    125:         &startpage($r,$showPoints);
                    126:     }
                    127:     $r->rflush();
1.1       bowersj2  128: 
1.29      albertel  129:     my $notshowSPRSlink = 
1.49      www       130:         (($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'external')
                    131:       || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'));
                    132:     my $notshowTotals=
                    133:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals';
1.17      bowersj2  134: 
1.1       bowersj2  135:     # Create the nav map
1.24      bowersj2  136:     my $navmap = Apache::lonnavmaps::navmap->new();
1.1       bowersj2  137: 
1.7       bowersj2  138:     if (!defined($navmap)) {
                    139:         my $requrl = $r->uri;
1.36      albertel  140:         $env{'user.error.msg'} = "$requrl:bre:0:0:Navamp initialization failed.";
1.7       bowersj2  141:         return HTTP_NOT_ACCEPTABLE;
                    142:     }
                    143: 
1.4       bowersj2  144:     # Keep this hash in sync with %statusIconMap in lonnavmaps; they
                    145:     # should match color/icon
                    146:     my $res = $navmap->firstResource(); # temp resource to access constants
1.1       bowersj2  147:  
1.29      albertel  148:     if (!$showPoints && !$notshowSPRSlink ) {
1.43      bisitz    149:         $r->print('<p>'
                    150:                  .&mt('This screen shows how many problems (or problem parts) you have completed'
                    151:                      .', and how many you have not yet done.'
                    152:                      .' You can also look at [_1]a detailed score sheet[_2].'
                    153:                      ,'<a href="/adm/studentcalc">','</a>')
                    154:                  .'</p>');
1.17      bowersj2  155:     }
                    156: 
1.43      bisitz    157:     $r->print('<p class="LC_info">'.&mt('This may take a few moments to display.').'</p>');
1.17      bowersj2  158: 
                    159:     $r->rflush();
1.2       bowersj2  160: 
1.1       bowersj2  161:     # End navmap using boilerplate
                    162: 
                    163:     my $iterator = $navmap->getIterator(undef, undef, undef, 1);
                    164:     my $depth = 1;
                    165:     $iterator->next(); # ignore first BEGIN_MAP
                    166:     my $curRes = $iterator->next();
1.4       bowersj2  167:     
1.5       bowersj2  168:     # General overview of the following: Walk along the course resources.
                    169:     # For every problem in the resource, tell its parent maps how many
                    170:     # parts and how many parts correct it has. After that, each map will
                    171:     # have a count of the total parts underneath it, correct and otherwise.
                    172:     # After that, we will walk through the course again and read off
                    173:     # maps in order, with their data. 
                    174:     # (If in the future people decide not to be cumulative, only add
                    175:     #  the counts to the parent map.)
1.17      bowersj2  176:     # For convenience, "totalParts" is also "totalPoints" when we're looking
                    177:     #  at points; I can't come up with a variable name that makes sense
                    178:     #  equally for both cases.
1.5       bowersj2  179: 
                    180:     my $totalParts = 0; my $totalPossible = 0; my $totalRight = 0;
1.28      bowersj2  181:     my $totalAttempted = 0;
1.14      bowersj2  182:     my $now = time();
1.28      bowersj2  183:     my $topLevelParts = 0; my $topLevelRight = 0; my $topLevelAttempted = 0;
1.5       bowersj2  184: 
                    185:     # Pre-run: Count parts correct
1.1       bowersj2  186:     while ( $depth > 0 ) {
                    187:         if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
                    188:         if ($curRes == $iterator->END_MAP()) { $depth--; }
                    189: 
1.7       bowersj2  190:         if (ref($curRes) && $curRes->is_problem() && !$curRes->randomout)
1.5       bowersj2  191:         {
                    192:             # Get number of correct, incorrect parts
                    193:             my $parts = $curRes->parts();
                    194:             my $partsRight = 0;
1.17      bowersj2  195: 	    my $partsCount = 0;
1.28      bowersj2  196: 	    my $partsAttempted = 0;
1.5       bowersj2  197:             my $stack = $iterator->getStack();
                    198:             
                    199:             for my $part (@{$parts}) {
1.28      bowersj2  200: 		my $completionStatus = $curRes->getCompletionStatus($part);
                    201: 		my $dateStatus = $curRes->getDateStatus($part);
                    202: 		
                    203:                 if ($completionStatus == $curRes->EXCUSED()) {
1.21      matthew   204:                     next;
                    205:                 }
1.17      bowersj2  206: 		if ($showPoints) {
1.28      bowersj2  207: 		    my $score = 0;
                    208: 		    # If we're not telling status and the answer date isn't passed yet, 
                    209: 		    # it's an "attempted" point
1.42      raeburn   210: 		    if ((($curRes->problemstatus($part) eq 'no') ||
                    211:                         ($curRes->problemstatus($part) eq 'no_feedback_ever')) &&
1.28      bowersj2  212: 			($dateStatus != $curRes->ANSWER_OPEN)) {
1.31      albertel  213: 			my $status = $curRes->simpleStatus($part);
                    214: 			if ($status == $curRes->ATTEMPTED) {
                    215: 			    $partsAttempted += $curRes->weight($part);
                    216: 			    $totalAttempted += $partsAttempted;
                    217: 			}
1.28      bowersj2  218: 		    } else {
1.39      albertel  219: 			$score = &Apache::grades::compute_points($curRes->weight($part), $curRes->awarded($part));
1.28      bowersj2  220: 		    }
1.17      bowersj2  221: 		    $partsRight += $score;
                    222: 		    $totalRight += $score;
1.19      bowersj2  223: 		    $partsCount += $curRes->weight($part);
1.18      bowersj2  224: 
1.17      bowersj2  225: 		    if ($curRes->opendate($part) < $now) {
1.20      bowersj2  226: 			$totalPossible += $curRes->weight($part);
1.17      bowersj2  227: 		    }
1.19      bowersj2  228: 		    $totalParts += $curRes->weight($part);
1.17      bowersj2  229: 		} else {
1.27      bowersj2  230: 		    my $status = $curRes->simpleStatus($part);
1.17      bowersj2  231: 		    my $thisright = 0;
                    232: 		    $partsCount++;
1.37      albertel  233: 		    if ($status == $curRes->CORRECT ||
                    234: 			$status == $curRes->PARTIALLY_CORRECT ) {
1.17      bowersj2  235: 			$partsRight++;
                    236: 			$totalRight++;
                    237: 			$thisright = 1;
                    238: 		    }
1.28      bowersj2  239: 
                    240: 		    if ($status == $curRes->ATTEMPTED) {
                    241: 			$partsAttempted++;
                    242: 			$totalAttempted++;
                    243: 		    }
1.17      bowersj2  244: 		    
                    245: 		    my $dateStatus = $curRes->getDateStatus($part);
1.19      bowersj2  246: 		    $totalParts++;
1.17      bowersj2  247: 		    if ($curRes->opendate($part) < $now) {
                    248: 			$totalPossible++;
                    249: 		    }
                    250: 		}
1.5       bowersj2  251:             }
1.15      bowersj2  252: 
                    253:             if ($depth == 1) { # in top-level only
1.19      bowersj2  254: 		$topLevelParts += $partsCount;
1.15      bowersj2  255: 		$topLevelRight += $partsRight;
1.28      bowersj2  256: 		$topLevelAttempted += $partsAttempted;
1.15      bowersj2  257: 	    }
                    258: 
1.5       bowersj2  259:             # Crawl down stack and record parts correct and total
                    260:             for my $res (@{$stack}) {
                    261:                 if (ref($res) && $res->is_map()) {
                    262:                     if (!defined($res->{DATA}->{CHILD_PARTS})) {
                    263:                         $res->{DATA}->{CHILD_PARTS} = 0;
                    264:                         $res->{DATA}->{CHILD_CORRECT} = 0;
1.28      bowersj2  265: 			$res->{DATA}->{CHILD_ATTEMPTED} = 0;
1.5       bowersj2  266:                     }
                    267:                     
1.17      bowersj2  268:                     $res->{DATA}->{CHILD_PARTS} += $partsCount;
1.5       bowersj2  269:                     $res->{DATA}->{CHILD_CORRECT} += $partsRight;
1.28      bowersj2  270: 		    $res->{DATA}->{CHILD_ATTEMPTED} += $partsAttempted;
1.5       bowersj2  271:                 }
                    272:             }
                    273:         }
                    274:         $curRes = $iterator->next();
                    275:     }
                    276: 
                    277:     $iterator = $navmap->getIterator(undef, undef, undef, 1);
1.9       matthew   278:     $depth = 1;
1.5       bowersj2  279:     $iterator->next(); # ignore first BEGIN_MAP
1.9       matthew   280:     $curRes = $iterator->next();
1.5       bowersj2  281: 
1.7       bowersj2  282:     my @start = (255, 255, 192);
1.5       bowersj2  283:     my @end   = (0, 192, 0);
                    284: 
                    285:     my $indentString = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
                    286: 
                    287:     # Second pass: Print the maps.
1.43      bisitz    288:     $r->print(&Apache::loncommon::start_data_table()
                    289:              .&Apache::loncommon::start_data_table_header_row()
                    290:              .'<th>'.&mt('Folder').'</th>');
1.49.6.5  raeburn   291:     my $title = &mt($showPoints ? "Points Scored" : "Done");
1.28      bowersj2  292:     if ($totalAttempted) {
                    293: 	$title .= " / " . &mt("Attempted");
                    294:     }
1.49      www       295:     $r->print("<th>$title".($notshowTotals?'':" / ".&mt('Total')).'</th>'
1.43      bisitz    296:              .&Apache::loncommon::end_data_table_header_row());
1.5       bowersj2  297:     while ($depth > 0) {
                    298:         if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
                    299:         if ($curRes == $iterator->END_MAP()) { $depth--; }
                    300: 
                    301:         if (ref($curRes) && $curRes->is_map()) {
                    302:             my $title = $curRes->compTitle();
                    303:             
                    304:             my $correct = $curRes->{DATA}->{CHILD_CORRECT};
                    305:             my $total = $curRes->{DATA}->{CHILD_PARTS};
1.28      bowersj2  306: 	    my $attempted = $curRes->{DATA}->{CHILD_ATTEMPTED};
1.5       bowersj2  307: 
1.6       bowersj2  308:             if ($total > 0) {
                    309:                 my $ratio;
                    310:                 $ratio = $correct / $total;
1.49.6.4  raeburn   311:                 my $color = &mixColors(\@start, \@end, $ratio);
1.43      bisitz    312:                 $r->print(&Apache::loncommon::start_data_table_row()
                    313:                          .'<td style="background-color:'.$color.';">');
1.6       bowersj2  314:                 
1.15      bowersj2  315: 		my $thisIndent = '';
                    316:                 for (my $i = 1; $i < $depth; $i++) { $thisIndent .= $indentString; }
1.6       bowersj2  317:                 
1.15      bowersj2  318:                 $r->print("$thisIndent$title</td>");
1.28      bowersj2  319: 		if ($totalAttempted) {
1.45      bisitz    320: 		    $r->print('<td valign="top">'
                    321:                              .$thisIndent
                    322:                              .'<span class="LC_nobreak">'
1.49      www       323:                              .$correct.' / '.$attempted.($notshowTotals?'':' / '.$total)
1.45      bisitz    324:                              .'</span></td>'
                    325:                              .&Apache::loncommon::end_data_table_row()
                    326:                     );
1.28      bowersj2  327: 		} else {
1.45      bisitz    328: 		    $r->print('<td valign="top">'
                    329:                              .$thisIndent
                    330:                              .'<span class="LC_nobreak">'
1.49      www       331:                              .$correct.($notshowTotals?'':' / '.$total)
1.45      bisitz    332:                              .'</span></td>'
1.43      bisitz    333:                              .&Apache::loncommon::end_data_table_row());
1.28      bowersj2  334: 		}
1.6       bowersj2  335:             }
1.5       bowersj2  336:         }
1.4       bowersj2  337: 
1.5       bowersj2  338:         $curRes = $iterator->next();
                    339:     }
1.4       bowersj2  340: 
1.6       bowersj2  341:     # If there were any problems at the top level, print an extra "catchall"
1.15      bowersj2  342:     if ($topLevelParts > 0) {
                    343:         my $ratio = $topLevelRight / $topLevelParts;
1.49.6.4  raeburn   344:         my $color = &mixColors(\@start, \@end, $ratio);
1.43      bisitz    345:         $r->print(&Apache::loncommon::start_data_table_row()
                    346:                  .'<td style="background-color:'.$color.';">');
1.25      www       347:         $r->print(&mt("Problems Not Contained In A Folder")."</td><td>");
1.43      bisitz    348:         $r->print("$topLevelRight / $topLevelParts</td>"
                    349:                  .&Apache::loncommon::end_data_table_row());
1.6       bowersj2  350:     }
1.4       bowersj2  351: 
1.35      albertel  352:     if ($showPoints) {
1.49.6.4  raeburn   353: 	my $maxHelpLink = &Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct");
1.2       bowersj2  354: 
1.34      www       355: 	$title = $showPoints ? "Points" : "Parts Done";
1.41      bisitz    356: 	my $totaltitle = $showPoints ? &mt("Awarded Total Points") : &mt("Total Parts Done");
1.43      bisitz    357: 	$r->print(&Apache::loncommon::start_data_table_row()
1.48      bisitz    358:                  .'<td colspan="2" align="right">'.$totaltitle.': <b>'.$totalRight.'</b><br />');
                    359: 	$r->print(&mt('Max Possible To Date')." $maxHelpLink: <b>$totalPossible</b><br />");
1.34      www       360: 	$title = $showPoints ? "Points" : "Parts";
1.43      bisitz    361: 	$r->print(&mt("Total $title In Course").': <b>'.$totalParts.'</b></td>'
                    362:                  .&Apache::loncommon::end_data_table_row());
1.34      www       363:     }
1.1       bowersj2  364: 
1.43      bisitz    365:     $r->print(&Apache::loncommon::end_data_table()
                    366:              .&Apache::loncommon::end_page());
1.1       bowersj2  367: 
                    368:     return OK;
1.5       bowersj2  369: }
                    370: 
1.49.6.4  raeburn   371: sub startpage {
                    372:     my ($r,$showPoints) = @_;
                    373:     my $title = "Grading and Statistics";#$showPoints ? "Points Display" : "Completed Problems Display";
                    374:     my $brcrum = [{href=>"/adm/quickgrades",text => "Points Display"}];
                    375:     $r->print(&Apache::loncommon::start_page($title,undef,
                    376:                                             {'bread_crumbs' => $brcrum})
                    377:              );
                    378: }
                    379: 
1.5       bowersj2  380: # Pass this two refs to arrays for the start and end color, and a number
                    381: # from 0 to 1 for how much of the latter you want to mix in. It will
                    382: # return a string ready to show ("#FFC309");
                    383: sub mixColors {
                    384:     my $start = shift;
                    385:     my $end = shift;
                    386:     my $ratio = shift;
                    387:     
1.9       matthew   388:     my ($a,$b);
1.5       bowersj2  389:     my $final = "";
1.9       matthew   390:     $a = $start->[0]; $b = $end->[0];
1.5       bowersj2  391:     my $mix1 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
1.9       matthew   392:     $a = $start->[1]; $b = $end->[1];
1.5       bowersj2  393:     my $mix2 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
1.9       matthew   394:     $a = $start->[2]; $b = $end->[2];
1.5       bowersj2  395:     my $mix3 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
                    396: 
1.16      bowersj2  397:     $final = sprintf "%02x%02x%02x", $mix1, $mix2, $mix3;
1.5       bowersj2  398:     return "#" . $final;
1.1       bowersj2  399: }
                    400: 
                    401: 1;

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