Return to lonquickgrades.pm CVS log

Up to [LON-CAPA] / loncom / interface

- Use LON-CAPA standard table for quick grades table
- Keep multicolor background settings, but switch from HTML attribute "bgcolor=..." to style="background-color=..." needed to keep this functional
- Corrected table row closure (was "<tr>" instead of "</tr>")
- Added missing &mt() call to introduction text for detailed scores table
- Added info style to info text about time consumption

    1: # The LearningOnline Network with CAPA
    2: # Quick Student Grades Display
    3: #
    4: # $Id: lonquickgrades.pm,v 1.43 2008/10/16 16:35:53 bisitz Exp $
    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: # Created Nov. 14, 2002 by Jeremy Bowers
   29: 
   30: package Apache::lonquickgrades;
   31: 
   32: use strict;
   33: use Apache::Constants qw(:common :http);
   34: use POSIX;
   35: use Apache::loncommon;
   36: use Apache::lonlocal;
   37: use Apache::lonnet;
   38: use Apache::grades;
   39: 
   40: sub handler {
   41:     my $r = shift;
   42:     return real_handler($r);
   43: }
   44: 
   45: sub real_handler {
   46:     my $r = shift;
   47: 
   48:     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
   49: 
   50:     # Handle header-only request
   51:     if ($env{'browser.mathml'}) {
   52: 	&Apache::loncommon::content_type($r,'text/xml');
   53:     } else {
   54: 	&Apache::loncommon::content_type($r,'text/html');
   55:     }
   56:     if ($r->header_only) {
   57: 	$r->send_http_header;
   58:         return OK;
   59:     }
   60: 
   61:     # Send header, don't cache this page
   62:     &Apache::loncommon::no_cache($r);
   63:     $r->send_http_header;
   64: 
   65:     my $showPoints = 
   66:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard';
   67:     my $notshowSPRSlink = 
   68:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'external';
   69: 
   70:     # Create the nav map
   71:     my $navmap = Apache::lonnavmaps::navmap->new();
   72: 
   73:     if (!defined($navmap)) {
   74:         my $requrl = $r->uri;
   75:         $env{'user.error.msg'} = "$requrl:bre:0:0:Navamp initialization failed.";
   76:         return HTTP_NOT_ACCEPTABLE;
   77:     }
   78: 
   79:     # Keep this hash in sync with %statusIconMap in lonnavmaps; they
   80:     # should match color/icon
   81:     my $res = $navmap->firstResource(); # temp resource to access constants
   82:  
   83:     # Header
   84:     my $title = $showPoints ? "Points Display" : "Completed Problems Display";
   85:     $r->print(&Apache::loncommon::start_page($title));
   86: 
   87:     if (!$showPoints && !$notshowSPRSlink ) {
   88:         $r->print('<p>'
   89:                  .&mt('This screen shows how many problems (or problem parts) you have completed'
   90:                      .', and how many you have not yet done.'
   91:                      .' You can also look at [_1]a detailed score sheet[_2].'
   92:                      ,'<a href="/adm/studentcalc">','</a>')
   93:                  .'</p>');
   94:     }
   95: 
   96:     $r->print('<p class="LC_info">'.&mt('This may take a few moments to display.').'</p>');
   97: 
   98:     $r->rflush();
   99: 
  100:     # End navmap using boilerplate
  101: 
  102:     my $iterator = $navmap->getIterator(undef, undef, undef, 1);
  103:     my $depth = 1;
  104:     $iterator->next(); # ignore first BEGIN_MAP
  105:     my $curRes = $iterator->next();
  106:     
  107:     # General overview of the following: Walk along the course resources.
  108:     # For every problem in the resource, tell its parent maps how many
  109:     # parts and how many parts correct it has. After that, each map will
  110:     # have a count of the total parts underneath it, correct and otherwise.
  111:     # After that, we will walk through the course again and read off
  112:     # maps in order, with their data. 
  113:     # (If in the future people decide not to be cumulative, only add
  114:     #  the counts to the parent map.)
  115:     # For convenience, "totalParts" is also "totalPoints" when we're looking
  116:     #  at points; I can't come up with a variable name that makes sense
  117:     #  equally for both cases.
  118: 
  119:     my $totalParts = 0; my $totalPossible = 0; my $totalRight = 0;
  120:     my $totalAttempted = 0;
  121:     my $now = time();
  122:     my $topLevelParts = 0; my $topLevelRight = 0; my $topLevelAttempted = 0;
  123: 
  124:     # Pre-run: Count parts correct
  125:     while ( $depth > 0 ) {
  126:         if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
  127:         if ($curRes == $iterator->END_MAP()) { $depth--; }
  128: 
  129:         if (ref($curRes) && $curRes->is_problem() && !$curRes->randomout)
  130:         {
  131:             # Get number of correct, incorrect parts
  132:             my $parts = $curRes->parts();
  133:             my $partsRight = 0;
  134: 	    my $partsCount = 0;
  135: 	    my $partsAttempted = 0;
  136:             my $stack = $iterator->getStack();
  137:             
  138:             for my $part (@{$parts}) {
  139: 		my $completionStatus = $curRes->getCompletionStatus($part);
  140: 		my $dateStatus = $curRes->getDateStatus($part);
  141: 		
  142:                 if ($completionStatus == $curRes->EXCUSED()) {
  143:                     next;
  144:                 }
  145: 		if ($showPoints) {
  146: 		    my $score = 0;
  147: 		    # If we're not telling status and the answer date isn't passed yet, 
  148: 		    # it's an "attempted" point
  149: 		    if ((($curRes->problemstatus($part) eq 'no') ||
  150:                         ($curRes->problemstatus($part) eq 'no_feedback_ever')) &&
  151: 			($dateStatus != $curRes->ANSWER_OPEN)) {
  152: 			my $status = $curRes->simpleStatus($part);
  153: 			if ($status == $curRes->ATTEMPTED) {
  154: 			    $partsAttempted += $curRes->weight($part);
  155: 			    $totalAttempted += $partsAttempted;
  156: 			}
  157: 		    } else {
  158: 			$score = &Apache::grades::compute_points($curRes->weight($part), $curRes->awarded($part));
  159: 		    }
  160: 		    $partsRight += $score;
  161: 		    $totalRight += $score;
  162: 		    $partsCount += $curRes->weight($part);
  163: 
  164: 		    if ($curRes->opendate($part) < $now) {
  165: 			$totalPossible += $curRes->weight($part);
  166: 		    }
  167: 		    $totalParts += $curRes->weight($part);
  168: 		} else {
  169: 		    my $status = $curRes->simpleStatus($part);
  170: 		    my $thisright = 0;
  171: 		    $partsCount++;
  172: 		    if ($status == $curRes->CORRECT ||
  173: 			$status == $curRes->PARTIALLY_CORRECT ) {
  174: 			$partsRight++;
  175: 			$totalRight++;
  176: 			$thisright = 1;
  177: 		    }
  178: 
  179: 		    if ($status == $curRes->ATTEMPTED) {
  180: 			$partsAttempted++;
  181: 			$totalAttempted++;
  182: 		    }
  183: 		    
  184: 		    my $dateStatus = $curRes->getDateStatus($part);
  185: 		    $totalParts++;
  186: 		    if ($curRes->opendate($part) < $now) {
  187: 			$totalPossible++;
  188: 		    }
  189: 		}
  190:             }
  191: 
  192:             if ($depth == 1) { # in top-level only
  193: 		$topLevelParts += $partsCount;
  194: 		$topLevelRight += $partsRight;
  195: 		$topLevelAttempted += $partsAttempted;
  196: 	    }
  197: 
  198:             # Crawl down stack and record parts correct and total
  199:             for my $res (@{$stack}) {
  200:                 if (ref($res) && $res->is_map()) {
  201:                     if (!defined($res->{DATA}->{CHILD_PARTS})) {
  202:                         $res->{DATA}->{CHILD_PARTS} = 0;
  203:                         $res->{DATA}->{CHILD_CORRECT} = 0;
  204: 			$res->{DATA}->{CHILD_ATTEMPTED} = 0;
  205:                     }
  206:                     
  207:                     $res->{DATA}->{CHILD_PARTS} += $partsCount;
  208:                     $res->{DATA}->{CHILD_CORRECT} += $partsRight;
  209: 		    $res->{DATA}->{CHILD_ATTEMPTED} += $partsAttempted;
  210:                 }
  211:             }
  212:         }
  213:         $curRes = $iterator->next();
  214:     }
  215: 
  216:     $iterator = $navmap->getIterator(undef, undef, undef, 1);
  217:     $depth = 1;
  218:     $iterator->next(); # ignore first BEGIN_MAP
  219:     $curRes = $iterator->next();
  220: 
  221:     my @start = (255, 255, 192);
  222:     my @end   = (0, 192, 0);
  223: 
  224:     my $indentString = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
  225: 
  226:     # Second pass: Print the maps.
  227:     $r->print(&Apache::loncommon::start_data_table()
  228:              .&Apache::loncommon::start_data_table_header_row()
  229:              .'<th>'.&mt('Folder').'</th>');
  230:     $title = &mt($showPoints ? "Points Scored" : "Done");
  231:     if ($totalAttempted) {
  232: 	$title .= " / " . &mt("Attempted");
  233:     }
  234:     $r->print("<th>$title / ".&mt('Total').'</td>'
  235:              .&Apache::loncommon::end_data_table_header_row());
  236:     while ($depth > 0) {
  237:         if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
  238:         if ($curRes == $iterator->END_MAP()) { $depth--; }
  239: 
  240:         if (ref($curRes) && $curRes->is_map()) {
  241:             my $title = $curRes->compTitle();
  242:             
  243:             my $correct = $curRes->{DATA}->{CHILD_CORRECT};
  244:             my $total = $curRes->{DATA}->{CHILD_PARTS};
  245: 	    my $attempted = $curRes->{DATA}->{CHILD_ATTEMPTED};
  246: 
  247:             if ($total > 0) {
  248:                 my $ratio;
  249:                 $ratio = $correct / $total;
  250:                 my $color = mixColors(\@start, \@end, $ratio);
  251:                 $r->print(&Apache::loncommon::start_data_table_row()
  252:                          .'<td style="background-color:'.$color.';">');
  253:                 
  254: 		my $thisIndent = '';
  255:                 for (my $i = 1; $i < $depth; $i++) { $thisIndent .= $indentString; }
  256:                 
  257:                 $r->print("$thisIndent$title</td>");
  258: 		if ($totalAttempted) {
  259: 		    $r->print("<td valign='top'>$thisIndent<nobr>$correct / $attempted / $total</nobr></td>"
  260:                              .&Apache::loncommon::end_data_table_row());
  261: 		} else {
  262: 		    $r->print("<td valign='top'>$thisIndent<nobr>$correct / $total</nobr></td>"
  263:                              .&Apache::loncommon::end_data_table_row());
  264: 		}
  265:             }
  266:         }
  267: 
  268:         $curRes = $iterator->next();
  269:     }
  270: 
  271:     # If there were any problems at the top level, print an extra "catchall"
  272:     if ($topLevelParts > 0) {
  273:         my $ratio = $topLevelRight / $topLevelParts;
  274:         my $color = mixColors(\@start, \@end, $ratio);
  275:         $r->print(&Apache::loncommon::start_data_table_row()
  276:                  .'<td style="background-color:'.$color.';">');
  277:         $r->print(&mt("Problems Not Contained In A Folder")."</td><td>");
  278:         $r->print("$topLevelRight / $topLevelParts</td>"
  279:                  .&Apache::loncommon::end_data_table_row());
  280:     }
  281: 
  282:     if ($showPoints) {
  283: 	my $maxHelpLink = Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct");
  284: 
  285: 	$title = $showPoints ? "Points" : "Parts Done";
  286: 	my $totaltitle = $showPoints ? &mt("Awarded Total Points") : &mt("Total Parts Done");
  287: 	$r->print(&Apache::loncommon::start_data_table_row()
  288:                  .'<td colspan="2" align="right">'.$totaltitle.': <b>'.$totalRight.'</b><br>');
  289: 	$r->print(&mt("Max Possible To Date")." $maxHelpLink: <b>$totalPossible</b><br>");
  290: 	$title = $showPoints ? "Points" : "Parts";
  291: 	$r->print(&mt("Total $title In Course").': <b>'.$totalParts.'</b></td>'
  292:                  .&Apache::loncommon::end_data_table_row());
  293:     }
  294: 
  295:     $r->print(&Apache::loncommon::end_data_table()
  296:              .&Apache::loncommon::end_page());
  297: 
  298:     return OK;
  299: }
  300: 
  301: # Pass this two refs to arrays for the start and end color, and a number
  302: # from 0 to 1 for how much of the latter you want to mix in. It will
  303: # return a string ready to show ("#FFC309");
  304: sub mixColors {
  305:     my $start = shift;
  306:     my $end = shift;
  307:     my $ratio = shift;
  308:     
  309:     my ($a,$b);
  310:     my $final = "";
  311:     $a = $start->[0]; $b = $end->[0];
  312:     my $mix1 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
  313:     $a = $start->[1]; $b = $end->[1];
  314:     my $mix2 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
  315:     $a = $start->[2]; $b = $end->[2];
  316:     my $mix3 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
  317: 
  318:     $final = sprintf "%02x%02x%02x", $mix1, $mix2, $mix3;
  319:     return "#" . $final;
  320: }
  321: 
  322: 1;