--- loncom/interface/lonquickgrades.pm 2002/11/22 20:39:14 1.6 +++ loncom/interface/lonquickgrades.pm 2024/01/05 19:50:32 1.49.6.8.2.5 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Quick Student Grades Display # -# +# $Id: lonquickgrades.pm,v 1.49.6.8.2.5 2024/01/05 19:50:32 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,13 +25,17 @@ # # http://www.lon-capa.org/ # -# Created Nov. 14, 2002 by Jeremy Bowers package Apache::lonquickgrades; use strict; -use Apache::Constants qw(:common :http); +use Apache::Constants qw(:common :http REDIRECT); use POSIX; +use Apache::loncommon; +use Apache::lonlocal; +use Apache::lonnet; +use Apache::grades; +use Apache::lonuserstate; sub handler { my $r = shift; @@ -44,53 +48,251 @@ sub real_handler { &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); # Handle header-only request + if ($env{'browser.mathml'}) { + &Apache::loncommon::content_type($r,'text/xml'); + } else { + &Apache::loncommon::content_type($r,'text/html'); + } if ($r->header_only) { - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); - } else { - $r->content_type('text/html'); + $r->send_http_header; + return OK; + } + + my $cangrade=&Apache::lonnet::allowed('mgr'); + my $showPoints = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard'; + + my $reinitresult; + + if ($env{'request.course.id'}) { + my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my $clientip = &Apache::lonnet::get_requestor_ip($r); + my ($blocked,$blocktext) = + &Apache::loncommon::blocking_status('grades',$clientip,$cnum,$cdom); + if ($blocked) { + my $checkrole = "cm./$cdom/$cnum"; + if ($env{'request.course.sec'} ne '') { + $checkrole .= "/$env{'request.course.sec'}"; + } + unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) && + ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) { + &grades_blocked($r,$blocktext,$showPoints); + return OK; + } + } + } + + unless ($cangrade) { + # Check for critical messages and redirect if present. + my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'grades'); + if ($redirect) { + &Apache::loncommon::content_type($r,'text/html'); + $r->header_out(Location => $url); + return REDIRECT; + } + + # Check if course needs to be re-initialized + my $loncaparev = $r->dir_config('lonVersion'); + ($reinitresult,my @reinit) = &Apache::loncommon::needs_coursereinit($loncaparev); + + if ($reinitresult eq 'switch') { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + $r->print(&Apache::loncommon::check_release_result(@reinit)); + return OK; + } + my ($cid,$cnum,$cdom); + if ($reinitresult) { + $cid = $env{'request.course.id'}; + $cnum = $env{'course.'.$cid.'.num'}; + $cdom = $env{'course.'.$cid.'.domain'}; } + if (($reinitresult eq 'main') || ($reinitresult eq 'both')) { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + &startpage($r,$showPoints); + my $preamble = '
'. + '
'. + &mt('Your course session is being updated because of recent changes by course personnel.'). + ' '.&mt('Please be patient').'.
'. + '
'; + my %prog_state = &Apache::lonhtmlcommon::Create_PrgWin($r,undef,$preamble); + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Updating course')); + $r->rflush(); + my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum"); + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Finished!')); + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + my $closure = < +// + +ENDCLOSE + if ($ferr) { + $r->print($closure.&Apache::loncommon::end_page()); + my $requrl = $r->uri; + $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; + $env{'user.reinit'} = 1; + return HTTP_NOT_ACCEPTABLE; + } else { + $r->print($closure); + } + } + if (($reinitresult eq 'supp') || ($reinitresult eq 'both')) { + my $possdel; + if ($reinitresult eq 'supp') { + $possdel = 1; + } + my ($supplemental,$refs_updated) = &Apache::loncommon::get_supplemental($cnum,$cdom,'',$possdel); + unless ($refs_updated) { + &Apache::loncommon::set_supp_httprefs($cnum,$cdom,$supplemental); + } + } + } + + unless (($reinitresult eq 'main') || ($reinitresult eq 'both')) { + # Send header, don't cache this page + &Apache::loncommon::no_cache($r); $r->send_http_header; - return OK; + &startpage($r,$showPoints); } + $r->rflush(); + + &startGradeScreen($r); - # Send header, don't cache this page - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); +# +# Pick student +# + my $uname; + my $udom; + my $stdid; + if ($cangrade) { + if ($env{'form.uname'}) { $uname=$env{'form.uname'}; } + if ($env{'form.udom'}) { $udom=$env{'form.udom'}; } + if ($env{'form.id'}) { $stdid=$env{'form.id'}; } + if (($stdid) && ($udom)) { + $uname=(&Apache::lonnet::idget($udom,[$stdid],'ids'))[1]; + } + if (($stdid) && (!$uname)) { + $r->print('

'.&mt("Unknown Student/Employee ID: [_1]",$stdid).'

'); + $stdid=''; + } + if (($uname eq '') && ($udom eq '')) { + $uname = $env{'user.name'}; + $udom = $env{'user.domain'}; + } + $r->print('
'); + my $chooseopt=&Apache::loncommon::select_dom_form($udom,'udom').' '. + &Apache::loncommon::selectstudent_link('quickform','uname','udom'); + $r->print("

\n".&Apache::loncommon::studentbrowser_javascript()."\n"); + $r->print(&mt('For User [_1] or Student/Employee ID [_2] at Domain [_3]' + ,'' + ,' ' + ,$chooseopt). + '  

'); + if (($uname) && ($udom)) { + $r->print('

'.&mt('Full Name: [_1]',&Apache::loncommon::plainname($uname,$udom)).'

'); + } } else { - $r->content_type('text/html'); + $r->print('

'.&mt('This may take a few moments to display.').'

'); } - &Apache::loncommon::no_cache($r); - $r->send_http_header; + $r->rflush(); - # Create the nav map - my $navmap = Apache::lonnavmaps::navmap->new( - $ENV{"request.course.fn"}.".db", - $ENV{"request.course.fn"}."_parms.db", 1, 0); + my $notshowTotals= + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'; - # Keep this hash in sync with %statusIconMap in lonnavmaps; they - # should match color/icon - my $res = $navmap->firstResource(); # temp resource to access constants + my ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts, + $topLevelRight,$topLevelAttempted) = &getData($showPoints,$uname,$udom); - if (!defined($navmap)) { + if (ref($navmap)) { + my $nostdtotals; + if ($showPoints) { + if ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard') { + my $hidetotals = $env{'course.'.$env{'request.course.id'}.'.hidetotals'}; + if ($hidetotals eq 'all') { + $nostdtotals = 1; + } elsif ($hidetotals ne '') { + my $usec; + if ($cangrade) { + if (($uname eq $env{'user.name'}) && ($udom eq $env{'user.domain'})) { + $usec = $env{'request.course.sec'}; + } else { + $usec = &Apache::lonnet::getsection($udom,$uname,$env{'request.course.id'}); + } + } else { + $usec = $env{'request.course.sec'}; + } + if ($usec ne '') { + my %secnototals; + map { $secnototals{$_} = 1; } split(/,/,$hidetotals); + if ($secnototals{$usec}) { + $nostdtotals = 1; + } + } + } + } + } + &outputTable($r,$showPoints,$notshowTotals,$nostdtotals,$navmap, + $totalParts,$totalPossible,$totalRight,$totalAttempted, + $topLevelParts,$topLevelRight,$topLevelAttempted); + } else { + if ($cangrade) { $r->print("\n
\n"); } my $requrl = $r->uri; - $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; + $env{'user.error.msg'} = "$requrl:bre:0:0:Navmap initialization failed."; return HTTP_NOT_ACCEPTABLE; } - - # Header - $r->print(&Apache::loncommon::bodytag('Quick Score Display','', - '')); + if ($cangrade) { $r->print("\n\n"); } + &endGradeScreen($r); + return OK; +} + +sub grades_blocked { + my ($r,$blocktext,$caller) = @_; + my $title = 'Points Display'; + if ($caller eq 'spreadsheet') { + $title = 'Spreadsheet'; + } elsif ($env{'course.'.$env{'request.course.id'}.'.grading'} ne 'standard') { + $title = 'Completed Problems Display'; + } + my $brcrum = [{href=>"/adm/quickgrades",text => $title}]; + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/quickgrades', + text=> $title}); + my $breadcrumbs = &Apache::lonhtmlcommon::breadcrumbs($title); + &Apache::loncommon::content_type($r,'text/html'); + &Apache::loncommon::no_cache($r); + $r->send_http_header; + $r->print(&Apache::loncommon::start_page($title). + $breadcrumbs. + $blocktext. + &Apache::loncommon::end_page()); + return; +} + +# +# Go through the complete course and collect data +# - $navmap->init(); +sub getData { - # End navmap using boilerplate + my ($showPoints,$uname,$udom)=@_; + + # Create the nav map + my $navmap = Apache::lonnavmaps::navmap->new($uname,$udom); + + if (!defined($navmap)) { + return (); + } + + my $res = $navmap->firstResource(); # temp resource to access constants my $iterator = $navmap->getIterator(undef, undef, undef, 1); my $depth = 1; $iterator->next(); # ignore first BEGIN_MAP my $curRes = $iterator->next(); - + # General overview of the following: Walk along the course resources. # For every problem in the resource, tell its parent maps how many # parts and how many parts correct it has. After that, each map will @@ -99,99 +301,181 @@ sub real_handler { # maps in order, with their data. # (If in the future people decide not to be cumulative, only add # the counts to the parent map.) + # For convenience, "totalParts" is also "totalPoints" when we're looking + # at points; I can't come up with a variable name that makes sense + # equally for both cases. my $totalParts = 0; my $totalPossible = 0; my $totalRight = 0; + my $totalAttempted = 0; + my $now = time(); + my $topLevelParts = 0; my $topLevelRight = 0; my $topLevelAttempted = 0; # Pre-run: Count parts correct while ( $depth > 0 ) { if ($curRes == $iterator->BEGIN_MAP()) {$depth++;} if ($curRes == $iterator->END_MAP()) { $depth--; } - if (ref($curRes) && $curRes->is_problem()) + if (ref($curRes) && $curRes->is_gradable() && !$curRes->randomout) { # Get number of correct, incorrect parts my $parts = $curRes->parts(); - if (scalar(@{$parts}) > 1) { shift @{$parts}; } # lose the first "0" - $totalParts += scalar(@{$parts}); my $partsRight = 0; + my $partsCount = 0; + my $partsAttempted = 0; my $stack = $iterator->getStack(); for my $part (@{$parts}) { - my $status = $curRes->getCompletionStatus($part); - if ($status == $curRes->CORRECT || $status == $curRes->CORRECT_BY_OVERRIDE - || $status == $curRes->EXCUSED) { - $partsRight++; - $totalRight++; - } + my $dateStatus = $curRes->getDateStatus($part); + my $weight = $curRes->weight($part); + my $problemstatus = $curRes->problemstatus($part); - my $dateStatus = $curRes->getDateStatus($part); - if ($status != $curRes->OPEN_LATER) { - $totalPossible++; + if ($curRes->solved($part) eq 'excused') { + next; } + if ($showPoints) { + my $score = 0; + # If we're not telling status and the answer date isn't passed yet, + # it's an "attempted" point + if ((($problemstatus eq 'no') || + ($problemstatus eq 'no_feedback_ever')) && + ($dateStatus != $curRes->ANSWER_OPEN)) { + my $status = $curRes->simpleStatus($part); + if ($status == $curRes->ATTEMPTED) { + $partsAttempted += $weight; + $totalAttempted += $partsAttempted; + } + } else { + $score = &Apache::grades::compute_points($weight, $curRes->awarded($part)); + } + $partsRight += $score; + $totalRight += $score; + $partsCount += $weight; + + if ($curRes->opendate($part) < $now) { + $totalPossible += $weight; + } + $totalParts += $weight; + } else { + my $status = $curRes->simpleStatus($part); + my $thisright = 0; + $partsCount++; + if ($status == $curRes->CORRECT || + $status == $curRes->PARTIALLY_CORRECT ) { + $partsRight++; + $totalRight++; + $thisright = 1; + } + + if ($status == $curRes->ATTEMPTED) { + $partsAttempted++; + $totalAttempted++; + } + + $totalParts++; + if ($curRes->opendate($part) < $now) { + $totalPossible++; + } + } } - + + if ($depth == 1) { # in top-level only + $topLevelParts += $partsCount; + $topLevelRight += $partsRight; + $topLevelAttempted += $partsAttempted; + } + # Crawl down stack and record parts correct and total for my $res (@{$stack}) { if (ref($res) && $res->is_map()) { if (!defined($res->{DATA}->{CHILD_PARTS})) { $res->{DATA}->{CHILD_PARTS} = 0; $res->{DATA}->{CHILD_CORRECT} = 0; + $res->{DATA}->{CHILD_ATTEMPTED} = 0; } - $res->{DATA}->{CHILD_PARTS} += scalar(@{$parts}); + $res->{DATA}->{CHILD_PARTS} += $partsCount; $res->{DATA}->{CHILD_CORRECT} += $partsRight; + $res->{DATA}->{CHILD_ATTEMPTED} += $partsAttempted; } } } $curRes = $iterator->next(); } + return ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted, + $topLevelParts,$topLevelRight,$topLevelAttempted); +} - $iterator = $navmap->getIterator(undef, undef, undef, 1); - my $depth = 1; - $iterator->next(); # ignore first BEGIN_MAP - my $curRes = $iterator->next(); +# +# Outputting everything. +# + +sub outputTable { - my @start = (255, 255, 0); + my ($r,$showPoints,$notshowTotals,$nostdtotals,$navmap,$totalParts,$totalPossible, + $totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=@_; + + my @start = (255, 255, 192); my @end = (0, 192, 0); my $indentString = '     '; - my $unaccountedTotal = $totalParts; - my $unaccountedCorrect = $totalRight; - # Second pass: Print the maps. - $r->print(''); - $r->print('' . "\n\n"); + $r->print(&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .''); + my $title = &mt($showPoints ? "Points Scored" : "Done"); + if ($totalAttempted) { + $title .= " / " . &mt("Attempted"); + } + $r->print("' + .&Apache::loncommon::end_data_table_header_row()); +# +# Output of folder scores +# + + my $iterator = $navmap->getIterator(undef, undef, undef, 1); + my $depth = 1; + $iterator->next(); # ignore first BEGIN_MAP + my $curRes = $iterator->next(); + while ($depth > 0) { if ($curRes == $iterator->BEGIN_MAP()) {$depth++;} if ($curRes == $iterator->END_MAP()) { $depth--; } if (ref($curRes) && $curRes->is_map()) { - my $stack = $iterator->getStack(); - my $src = Apache::lonnavmaps::getLinkForResource($stack); - my $srcHasQuestion = $src =~ /\?/; - my $link = $src. - ($srcHasQuestion?'&':'?') . - 'symb='.&Apache::lonnet::escape($curRes->symb()). - '"'; my $title = $curRes->compTitle(); my $correct = $curRes->{DATA}->{CHILD_CORRECT}; my $total = $curRes->{DATA}->{CHILD_PARTS}; - - $unaccountedTotal -= $total; - $unaccountedCorrect -= $correct; + my $attempted = $curRes->{DATA}->{CHILD_ATTEMPTED}; if ($total > 0) { my $ratio; $ratio = $correct / $total; - my $color = mixColors(\@start, \@end, $ratio); - $r->print(""); - $r->print("\n"); + $r->print("$thisIndent$title"); + if ($totalAttempted) { + $r->print('' + .&Apache::loncommon::end_data_table_row() + ); + } else { + $r->print('' + .&Apache::loncommon::end_data_table_row()); + } } } @@ -199,26 +483,112 @@ sub real_handler { } # If there were any problems at the top level, print an extra "catchall" - if ($unaccountedTotal > 0) { - my $ratio = $unaccountedCorrect / $unaccountedTotal; - my $color = mixColors(\@start, \@end, $ratio); - $r->print(""); + if ($topLevelParts > 0) { + my $ratio = $topLevelRight / $topLevelParts; + my $color = &mixColors(\@start, \@end, $ratio); + $r->print(&Apache::loncommon::start_data_table_row() + .'" + .&Apache::loncommon::end_data_table_row()); + } + +# +# show totals (if applicable), close table +# + if ($showPoints) { + unless ($nostdtotals) { + my $maxHelpLink = &Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct"); + + $title = $showPoints ? "Points" : "Parts Done"; + my $totaltitle = $showPoints ? &mt("Awarded Total Points") : &mt("Total Parts Done"); + $r->print(&Apache::loncommon::start_data_table_row() + .'' + .&Apache::loncommon::end_data_table_row()); + } } - my $maxHelpLink = Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct"); + $r->print(&Apache::loncommon::end_data_table()); + return; +} - $r->print("\n\n"); +sub startpage { + my ($r,$showPoints) = @_; + my $title = "Grading and Statistics";#$showPoints ? "Points Display" : "Completed Problems Display"; + my $brcrum = [{href=>"/adm/quickgrades",text => "Points Display"}]; + $r->print(&Apache::loncommon::start_page($title,undef, + {'bread_crumbs' => $brcrum}) + ); +} +sub startGradeScreen { + my ($r)=@_; - $r->print("
SequenceCorrect / Total
'.&mt('Folder').'$title".($notshowTotals?'':" / ".&mt('Total')).'
"); + my $color = &mixColors(\@start, \@end, $ratio); + $r->print(&Apache::loncommon::start_data_table_row() + .''); - for (my $i = 1; $i < $depth; $i++) { $r->print($indentString); } + my $thisIndent = ''; + for (my $i = 1; $i < $depth; $i++) { $thisIndent .= $indentString; } - $r->print("$title$correct / $total
' + .$thisIndent + .'' + .$correct.' / '.$attempted.($notshowTotals?'':' / '.$total) + .'' + .$thisIndent + .'' + .$correct.($notshowTotals?'':' / '.$total) + .'
"); - $r->print("Problems Not Contained In Sequences"); - $r->print("$unaccountedCorrect / $unaccountedTotal
'); + $r->print(&mt("Problems Not Contained In A Folder").""); + $r->print("$topLevelRight / $topLevelParts'.$totaltitle.': '.$totalRight.'
'); + $r->print(&mt('Max Possible To Date')." $maxHelpLink: $totalPossible
"); + $title = $showPoints ? "Points" : "Parts"; + $r->print(&mt("Total $title In Course").': '.$totalParts.'
Total Parts Correct: $totalRight
"); - $r->print("Max Possible To Date $maxHelpLink: $totalPossible
"); - $r->print("Total Parts In Course: $totalParts
"); + my $showPoints = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard'; + my $hidetotals = + $env{'course.'.$env{'request.course.id'}.'.hidetotals'}; + my $notshowSPRSlink = + (($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'external') + || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals')); + my $notshowTotals = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'; + my $showSPRSlink = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'spreadsheet'; + + my $allowed_to_view = &Apache::lonnet::allowed('vgr',$env{'request.course.id'}); + if ((!$allowed_to_view) && ($env{'request.course.sec'} ne '')) { + $allowed_to_view = &Apache::lonnet::allowed('vgr', + "$env{'request.course.id'}/$env{'request.course.sec'}"); + } - $navmap->untieHashes(); + my $allowed_to_edit = &Apache::lonnet::allowed('mgr',$env{'request.course.id'}); + if ((!$allowed_to_edit) && ($env{'request.course.sec'} ne '')) { + $allowed_to_edit = &Apache::lonnet::allowed('mgr', + "$env{'request.course.id'}/$env{'request.course.sec'}"); + } - return OK; + if ($allowed_to_view) { + my @notes; + push(@notes,&mt('Students do not see total points.')) if ($notshowTotals); + push(@notes,&mt('Students do not see link to spreadsheet.')) if ($notshowSPRSlink); + push(@notes,&mt('Students will see points based on problem weights.')) if ($showPoints); + if (($showPoints) && ($hidetotals ne '')) { + if ($hidetotals eq 'all') { + push(@notes,&mt('Students do not see course totals.')); + } else { + my @secs = split(/,/,$hidetotals); + if (@secs == 1) { + push(@notes,&mt('Students in section [_1] do not see course totals.', + $hidetotals)); + } elsif (@secs > 1) { + push(@notes,&mt('Students in sections [_1] do not see course totals.', + join(', ',@secs))); + } + } + } + push(@notes,&mt('Students will see link to spreadsheet.')) if ($showSPRSlink); + push(@notes,&Apache::lonhtmlcommon::coursepreflink(&mt('Grade display settings'),'grading')); + $r->print(&Apache::loncommon::head_subbox(join('  ',@notes))); + } elsif (!$allowed_to_edit) { + if (!$showPoints && !$notshowSPRSlink ) { + $r->print(&Apache::loncommon::head_subbox( + &mt('This screen shows how many problems (or problem parts) you have completed' + .', and how many you have not yet done.' + .' You can also look at [_1]a detailed score sheet[_2].' + ,'',''))); + } + } + return; +} + +sub endGradeScreen { + my ($r)=@_; + $r->print(&Apache::loncommon::end_page()); + return; } # Pass this two refs to arrays for the start and end color, and a number @@ -229,15 +599,16 @@ sub mixColors { my $end = shift; my $ratio = shift; + my ($a,$b); my $final = ""; - my $a = $start->[0]; my $b = $end->[0]; + $a = $start->[0]; $b = $end->[0]; my $mix1 = POSIX::floor((1-$ratio)*$a + $ratio*$b); - my $a = $start->[1]; my $b = $end->[1]; + $a = $start->[1]; $b = $end->[1]; my $mix2 = POSIX::floor((1-$ratio)*$a + $ratio*$b); - my $a = $start->[2]; my $b = $end->[2]; + $a = $start->[2]; $b = $end->[2]; my $mix3 = POSIX::floor((1-$ratio)*$a + $ratio*$b); - my $final = sprintf "%2x%2x%2x", $mix1, $mix2, $mix3; + $final = sprintf "%02x%02x%02x", $mix1, $mix2, $mix3; return "#" . $final; }