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

1.1       bowersj2    1: # The LearningOnline Network with CAPA
                      2: # Quick Student Grades Display
                      3: #
1.55    ! www         4: # $Id: lonquickgrades.pm,v 1.54 2010/12/03 15:21:35 www 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;
                     32: use Apache::Constants qw(:common :http);
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.1       bowersj2   38: 
                     39: sub handler {
                     40:     my $r = shift;
1.5       bowersj2   41:     return real_handler($r);
                     42: }
                     43: 
                     44: sub real_handler {
                     45:     my $r = shift;
1.1       bowersj2   46: 
                     47:     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
                     48: 
                     49:     # Handle header-only request
1.40      albertel   50:     if ($env{'browser.mathml'}) {
                     51: 	&Apache::loncommon::content_type($r,'text/xml');
                     52:     } else {
                     53: 	&Apache::loncommon::content_type($r,'text/html');
                     54:     }
1.1       bowersj2   55:     if ($r->header_only) {
1.40      albertel   56: 	$r->send_http_header;
1.1       bowersj2   57:         return OK;
                     58:     }
                     59: 
                     60:     # Send header, don't cache this page
                     61:     &Apache::loncommon::no_cache($r);
                     62:     $r->send_http_header;
                     63: 
1.55    ! www        64:     my $showPoints =
1.36      albertel   65:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard';
1.55    ! www        66:     my $notshowSPRSlink =
1.49      www        67:         (($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'external')
                     68:       || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'));
                     69:     my $notshowTotals=
                     70:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals';
1.50      www        71:     my $showCategories=
                     72:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories';
                     73: 
1.17      bowersj2   74: 
1.47      schafran   75:     my $title = "Grading and Statistics";#$showPoints ? "Points Display" : "Completed Problems Display";
1.46      raeburn    76:     my $brcrum = [{href=>"/adm/quickgrades",text => "Points Display"}];
                     77:     $r->print(&Apache::loncommon::start_page($title,undef,
                     78:                                             {'bread_crumbs' => $brcrum})
                     79:              );
1.1       bowersj2   80: 
1.55    ! www        81:     &startGradeScreen($r,'quick');
1.17      bowersj2   82: 
                     83:     $r->rflush();
1.53      www        84: 
1.54      www        85: #    my $uname='korte';
                     86: #    my $udom='gerd';
                     87: 
                     88:     my $uname;
                     89:     my $udom;
1.53      www        90: 
                     91:     my ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=
                     92:        &getData($showPoints,$uname,$udom);
                     93: 
                     94:     if ($showCategories) {
                     95:        &outputCategories($r,$showPoints,$notshowTotals,
                     96:                  $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted);
                     97:     } else {
                     98:        &outputTable($r,$showPoints,$notshowTotals,
1.51      www        99:                  $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted);
1.53      www       100:     }
1.55    ! www       101:     &endGradeScreen($r);
1.51      www       102:     return OK;
                    103: 
                    104: }
1.2       bowersj2  105: 
1.55    ! www       106: sub startGradeScreen {
        !           107:     my ($r,$mode)=@_;
        !           108: 
        !           109:     my $showPoints =
        !           110:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard';
        !           111:     my $notshowSPRSlink =
        !           112:         (($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'external')
        !           113:       || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals')
        !           114:       || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories'));
        !           115:     my $notshowTotals=
        !           116:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals';
        !           117:     my $showCategories=
        !           118:         $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories';
        !           119: 
        !           120:     my $allowed_to_view =  &Apache::lonnet::allowed('vgr',$env{'request.course.id'});
        !           121:     my $allowed_to_edit =  &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
        !           122: 
        !           123:     if ($allowed_to_view) {
        !           124:        $r->print('<table><tr>');
        !           125:        if ($notshowTotals)  { $r->print ('<td>'.&mt('Students do not see total points.').'</td>'); }
        !           126:        if ($notshowSPRSlink){ $r->print ('<td>'.&mt('Students do not see link to spreadsheet.').'</td>'); }
        !           127:        if ($showPoints)     { $r->print ('<td>'.&mt('Students will see points based on problem weights.').'</td>'); }
        !           128:        if ($showCategories) { $r->print ('<td>'.&mt('Students will see points based on categories.').'</td>'); }
        !           129:        $r->print('<td>'.&Apache::lonhtmlcommon::coursepreflink(&mt('Grade display settings'),'grading').'</td></td></table>');
        !           130:     }
        !           131: 
        !           132: 
        !           133:     $r->print('<ul class="LC_TabContentBigger" id="main">');
        !           134:     $r->print('<li'.($mode eq 'quick'?' class="active"':'').'><a href="/adm/quickgrades"><b>'.
        !           135:                                           ($showPoints?&mt('Points'):($showCategories?&mt('Grades'):&mt('Completion'))).'</b></a></li>');
        !           136: 
        !           137:     if (!($showPoints || $notshowSPRSlink) || ($allowed_to_view)) {
        !           138:        $r->print('<li'.($mode eq 'spreadsheet'?' class="active"':'').'><a href="/adm/'.($allowed_to_view?'classcalc':'studentcalc').'"><b>'.
        !           139:                                                                  &mt('Spreadsheet').'</b></a></li>');
        !           140:     }
        !           141:     $r->print('</ul>');
        !           142:     $r->print('<div class="LC_Box" style="clear:both;margin:0;"><div id="maincoursedoc" style="margin:0 0;padding:0 0;"><div class="LC_ContentBox" id="mainCourseDocuments" style="display: block;">');
        !           143: }
        !           144: 
        !           145: sub endGradeScreen {
        !           146:    my ($r)=@_;
        !           147:    $r->print('</div></div></div>');
        !           148: }
        !           149: 
        !           150: 
1.51      www       151: sub getData {
                    152: 
1.53      www       153:     my ($showPoints,$uname,$udom)=@_;
                    154: 
                    155:     &Apache::lonnet::logthis("About to call with $uname $udom");
1.51      www       156: 
                    157:     # Create the nav map
1.53      www       158:     my $navmap = Apache::lonnavmaps::navmap->new($uname,$udom);
1.51      www       159: 
                    160:     my $res = $navmap->firstResource(); # temp resource to access constants
1.1       bowersj2  161: 
                    162:     my $iterator = $navmap->getIterator(undef, undef, undef, 1);
                    163:     my $depth = 1;
                    164:     $iterator->next(); # ignore first BEGIN_MAP
                    165:     my $curRes = $iterator->next();
1.4       bowersj2  166:     
1.5       bowersj2  167:     # General overview of the following: Walk along the course resources.
                    168:     # For every problem in the resource, tell its parent maps how many
                    169:     # parts and how many parts correct it has. After that, each map will
                    170:     # have a count of the total parts underneath it, correct and otherwise.
                    171:     # After that, we will walk through the course again and read off
                    172:     # maps in order, with their data. 
                    173:     # (If in the future people decide not to be cumulative, only add
                    174:     #  the counts to the parent map.)
1.17      bowersj2  175:     # For convenience, "totalParts" is also "totalPoints" when we're looking
                    176:     #  at points; I can't come up with a variable name that makes sense
                    177:     #  equally for both cases.
1.5       bowersj2  178: 
                    179:     my $totalParts = 0; my $totalPossible = 0; my $totalRight = 0;
1.28      bowersj2  180:     my $totalAttempted = 0;
1.14      bowersj2  181:     my $now = time();
1.28      bowersj2  182:     my $topLevelParts = 0; my $topLevelRight = 0; my $topLevelAttempted = 0;
1.5       bowersj2  183: 
                    184:     # Pre-run: Count parts correct
1.1       bowersj2  185:     while ( $depth > 0 ) {
                    186:         if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
                    187:         if ($curRes == $iterator->END_MAP()) { $depth--; }
                    188: 
1.7       bowersj2  189:         if (ref($curRes) && $curRes->is_problem() && !$curRes->randomout)
1.5       bowersj2  190:         {
                    191:             # Get number of correct, incorrect parts
                    192:             my $parts = $curRes->parts();
                    193:             my $partsRight = 0;
1.17      bowersj2  194: 	    my $partsCount = 0;
1.28      bowersj2  195: 	    my $partsAttempted = 0;
1.5       bowersj2  196:             my $stack = $iterator->getStack();
                    197:             
                    198:             for my $part (@{$parts}) {
1.28      bowersj2  199: 		my $completionStatus = $curRes->getCompletionStatus($part);
                    200: 		my $dateStatus = $curRes->getDateStatus($part);
                    201: 		
                    202:                 if ($completionStatus == $curRes->EXCUSED()) {
1.21      matthew   203:                     next;
                    204:                 }
1.17      bowersj2  205: 		if ($showPoints) {
1.28      bowersj2  206: 		    my $score = 0;
                    207: 		    # If we're not telling status and the answer date isn't passed yet, 
                    208: 		    # it's an "attempted" point
1.42      raeburn   209: 		    if ((($curRes->problemstatus($part) eq 'no') ||
                    210:                         ($curRes->problemstatus($part) eq 'no_feedback_ever')) &&
1.28      bowersj2  211: 			($dateStatus != $curRes->ANSWER_OPEN)) {
1.31      albertel  212: 			my $status = $curRes->simpleStatus($part);
                    213: 			if ($status == $curRes->ATTEMPTED) {
                    214: 			    $partsAttempted += $curRes->weight($part);
                    215: 			    $totalAttempted += $partsAttempted;
                    216: 			}
1.28      bowersj2  217: 		    } else {
1.39      albertel  218: 			$score = &Apache::grades::compute_points($curRes->weight($part), $curRes->awarded($part));
1.28      bowersj2  219: 		    }
1.17      bowersj2  220: 		    $partsRight += $score;
                    221: 		    $totalRight += $score;
1.19      bowersj2  222: 		    $partsCount += $curRes->weight($part);
1.18      bowersj2  223: 
1.17      bowersj2  224: 		    if ($curRes->opendate($part) < $now) {
1.20      bowersj2  225: 			$totalPossible += $curRes->weight($part);
1.17      bowersj2  226: 		    }
1.19      bowersj2  227: 		    $totalParts += $curRes->weight($part);
1.17      bowersj2  228: 		} else {
1.27      bowersj2  229: 		    my $status = $curRes->simpleStatus($part);
1.17      bowersj2  230: 		    my $thisright = 0;
                    231: 		    $partsCount++;
1.37      albertel  232: 		    if ($status == $curRes->CORRECT ||
                    233: 			$status == $curRes->PARTIALLY_CORRECT ) {
1.17      bowersj2  234: 			$partsRight++;
                    235: 			$totalRight++;
                    236: 			$thisright = 1;
                    237: 		    }
1.28      bowersj2  238: 
                    239: 		    if ($status == $curRes->ATTEMPTED) {
                    240: 			$partsAttempted++;
                    241: 			$totalAttempted++;
                    242: 		    }
1.17      bowersj2  243: 		    
                    244: 		    my $dateStatus = $curRes->getDateStatus($part);
1.19      bowersj2  245: 		    $totalParts++;
1.17      bowersj2  246: 		    if ($curRes->opendate($part) < $now) {
                    247: 			$totalPossible++;
                    248: 		    }
                    249: 		}
1.5       bowersj2  250:             }
1.15      bowersj2  251: 
                    252:             if ($depth == 1) { # in top-level only
1.19      bowersj2  253: 		$topLevelParts += $partsCount;
1.15      bowersj2  254: 		$topLevelRight += $partsRight;
1.28      bowersj2  255: 		$topLevelAttempted += $partsAttempted;
1.15      bowersj2  256: 	    }
                    257: 
1.5       bowersj2  258:             # Crawl down stack and record parts correct and total
                    259:             for my $res (@{$stack}) {
                    260:                 if (ref($res) && $res->is_map()) {
                    261:                     if (!defined($res->{DATA}->{CHILD_PARTS})) {
                    262:                         $res->{DATA}->{CHILD_PARTS} = 0;
                    263:                         $res->{DATA}->{CHILD_CORRECT} = 0;
1.28      bowersj2  264: 			$res->{DATA}->{CHILD_ATTEMPTED} = 0;
1.5       bowersj2  265:                     }
                    266:                     
1.17      bowersj2  267:                     $res->{DATA}->{CHILD_PARTS} += $partsCount;
1.5       bowersj2  268:                     $res->{DATA}->{CHILD_CORRECT} += $partsRight;
1.28      bowersj2  269: 		    $res->{DATA}->{CHILD_ATTEMPTED} += $partsAttempted;
1.5       bowersj2  270:                 }
                    271:             }
                    272:         }
                    273:         $curRes = $iterator->next();
                    274:     }
1.51      www       275:     return ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted);
                    276: }
                    277: 
                    278: #
                    279: # Outputting everything.
                    280: #
                    281: 
                    282: sub outputTable {
1.5       bowersj2  283: 
1.51      www       284:     my ($r,$showPoints,$notshowTotals,
                    285:            $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=@_;
1.5       bowersj2  286: 
1.7       bowersj2  287:     my @start = (255, 255, 192);
1.5       bowersj2  288:     my @end   = (0, 192, 0);
                    289: 
                    290:     my $indentString = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
                    291: 
                    292:     # Second pass: Print the maps.
1.43      bisitz    293:     $r->print(&Apache::loncommon::start_data_table()
                    294:              .&Apache::loncommon::start_data_table_header_row()
                    295:              .'<th>'.&mt('Folder').'</th>');
1.51      www       296:     my $title = &mt($showPoints ? "Points Scored" : "Done");
1.28      bowersj2  297:     if ($totalAttempted) {
1.51      www       298:         $title .= " / " . &mt("Attempted");
1.28      bowersj2  299:     }
1.49      www       300:     $r->print("<th>$title".($notshowTotals?'':" / ".&mt('Total')).'</th>'
1.43      bisitz    301:              .&Apache::loncommon::end_data_table_header_row());
1.51      www       302: #
                    303: # Output of folder scores
                    304: #
                    305: 
                    306:     my $iterator = $navmap->getIterator(undef, undef, undef, 1);
                    307:     my $depth = 1;
                    308:     $iterator->next(); # ignore first BEGIN_MAP
                    309:     my $curRes = $iterator->next();
                    310: 
1.5       bowersj2  311:     while ($depth > 0) {
                    312:         if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
                    313:         if ($curRes == $iterator->END_MAP()) { $depth--; }
                    314: 
                    315:         if (ref($curRes) && $curRes->is_map()) {
                    316:             my $title = $curRes->compTitle();
                    317:             
                    318:             my $correct = $curRes->{DATA}->{CHILD_CORRECT};
                    319:             my $total = $curRes->{DATA}->{CHILD_PARTS};
1.28      bowersj2  320: 	    my $attempted = $curRes->{DATA}->{CHILD_ATTEMPTED};
1.5       bowersj2  321: 
1.6       bowersj2  322:             if ($total > 0) {
                    323:                 my $ratio;
                    324:                 $ratio = $correct / $total;
1.51      www       325:                 my $color = &mixColors(\@start, \@end, $ratio);
1.43      bisitz    326:                 $r->print(&Apache::loncommon::start_data_table_row()
                    327:                          .'<td style="background-color:'.$color.';">');
1.6       bowersj2  328:                 
1.15      bowersj2  329: 		my $thisIndent = '';
                    330:                 for (my $i = 1; $i < $depth; $i++) { $thisIndent .= $indentString; }
1.6       bowersj2  331:                 
1.15      bowersj2  332:                 $r->print("$thisIndent$title</td>");
1.28      bowersj2  333: 		if ($totalAttempted) {
1.45      bisitz    334: 		    $r->print('<td valign="top">'
                    335:                              .$thisIndent
                    336:                              .'<span class="LC_nobreak">'
1.49      www       337:                              .$correct.' / '.$attempted.($notshowTotals?'':' / '.$total)
1.45      bisitz    338:                              .'</span></td>'
                    339:                              .&Apache::loncommon::end_data_table_row()
                    340:                     );
1.28      bowersj2  341: 		} else {
1.45      bisitz    342: 		    $r->print('<td valign="top">'
                    343:                              .$thisIndent
                    344:                              .'<span class="LC_nobreak">'
1.49      www       345:                              .$correct.($notshowTotals?'':' / '.$total)
1.45      bisitz    346:                              .'</span></td>'
1.43      bisitz    347:                              .&Apache::loncommon::end_data_table_row());
1.28      bowersj2  348: 		}
1.6       bowersj2  349:             }
1.5       bowersj2  350:         }
1.4       bowersj2  351: 
1.5       bowersj2  352:         $curRes = $iterator->next();
                    353:     }
1.4       bowersj2  354: 
1.6       bowersj2  355:     # If there were any problems at the top level, print an extra "catchall"
1.15      bowersj2  356:     if ($topLevelParts > 0) {
                    357:         my $ratio = $topLevelRight / $topLevelParts;
1.6       bowersj2  358:         my $color = mixColors(\@start, \@end, $ratio);
1.43      bisitz    359:         $r->print(&Apache::loncommon::start_data_table_row()
                    360:                  .'<td style="background-color:'.$color.';">');
1.25      www       361:         $r->print(&mt("Problems Not Contained In A Folder")."</td><td>");
1.43      bisitz    362:         $r->print("$topLevelRight / $topLevelParts</td>"
                    363:                  .&Apache::loncommon::end_data_table_row());
1.6       bowersj2  364:     }
1.4       bowersj2  365: 
1.51      www       366: #
                    367: # show totals (if applicable), close table
                    368: #
1.35      albertel  369:     if ($showPoints) {
1.51      www       370:         my $maxHelpLink = Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct");
1.2       bowersj2  371: 
1.51      www       372:         $title = $showPoints ? "Points" : "Parts Done";
                    373:         my $totaltitle = $showPoints ? &mt("Awarded Total Points") : &mt("Total Parts Done");
                    374:         $r->print(&Apache::loncommon::start_data_table_row()
1.48      bisitz    375:                  .'<td colspan="2" align="right">'.$totaltitle.': <b>'.$totalRight.'</b><br />');
1.51      www       376:         $r->print(&mt('Max Possible To Date')." $maxHelpLink: <b>$totalPossible</b><br />");
                    377:         $title = $showPoints ? "Points" : "Parts";
                    378:         $r->print(&mt("Total $title In Course").': <b>'.$totalParts.'</b></td>'
1.43      bisitz    379:                  .&Apache::loncommon::end_data_table_row());
1.34      www       380:     }
1.1       bowersj2  381: 
1.43      bisitz    382:     $r->print(&Apache::loncommon::end_data_table()
                    383:              .&Apache::loncommon::end_page());
1.1       bowersj2  384: 
1.5       bowersj2  385: }
                    386: 
1.53      www       387: #
                    388: # Outputting category-based grades.
                    389: #
                    390: 
                    391: sub outputCategories {
                    392: 
                    393:     my ($r,$showPoints,$notshowTotals,
                    394:            $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=@_;
                    395: }
                    396: 
1.5       bowersj2  397: # Pass this two refs to arrays for the start and end color, and a number
                    398: # from 0 to 1 for how much of the latter you want to mix in. It will
                    399: # return a string ready to show ("#FFC309");
1.51      www       400: 
1.5       bowersj2  401: sub mixColors {
                    402:     my $start = shift;
                    403:     my $end = shift;
                    404:     my $ratio = shift;
                    405:     
1.9       matthew   406:     my ($a,$b);
1.5       bowersj2  407:     my $final = "";
1.9       matthew   408:     $a = $start->[0]; $b = $end->[0];
1.5       bowersj2  409:     my $mix1 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
1.9       matthew   410:     $a = $start->[1]; $b = $end->[1];
1.5       bowersj2  411:     my $mix2 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
1.9       matthew   412:     $a = $start->[2]; $b = $end->[2];
1.5       bowersj2  413:     my $mix3 = POSIX::floor((1-$ratio)*$a + $ratio*$b);
                    414: 
1.16      bowersj2  415:     $final = sprintf "%02x%02x%02x", $mix1, $mix2, $mix3;
1.5       bowersj2  416:     return "#" . $final;
1.1       bowersj2  417: }
                    418: 
                    419: 1;

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