Return to lonquickgrades.pm CVS log

Up to [LON-CAPA] / loncom / interface

lonnavmaps are now maximally lazy; no processing is performed until it
is needed, except in cases where it makes sense to grab all data for the
course at a time.

As a result, the Apache::lonnavmaps::navmap->new() call no longer needs
any arguments; it assumes you're using the current user's navmaps and
generates the other data as needed.

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