--- loncom/interface/lonquickgrades.pm 2002/11/26 14:45:25 1.7 +++ loncom/interface/lonquickgrades.pm 2011/02/20 21:56:25 1.68 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Quick Student Grades Display # -# +# $Id: lonquickgrades.pm,v 1.68 2011/02/20 21:56:25 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,13 +25,16 @@ # # http://www.lon-capa.org/ # -# Created Nov. 14, 2002 by Jeremy Bowers package Apache::lonquickgrades; use strict; use Apache::Constants qw(:common :http); use POSIX; +use Apache::loncommon; +use Apache::lonlocal; +use Apache::lonnet; +use Apache::grades; sub handler { my $r = shift; @@ -44,59 +47,136 @@ 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; + $r->send_http_header; return OK; } # Send header, don't cache this page - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); - } else { - $r->content_type('text/html'); - } &Apache::loncommon::no_cache($r); $r->send_http_header; - # Create the nav map - my $navmap = Apache::lonnavmaps::navmap->new( - $ENV{"request.course.fn"}.".db", - $ENV{"request.course.fn"}."_parms.db", 1, 0); - - if (!defined($navmap)) { - my $requrl = $r->uri; - $ENV{'user.error.msg'} = "$requrl:bre:0:0:Navamp initialization failed."; - return HTTP_NOT_ACCEPTABLE; + my $showPoints = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard'; + 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 $showCategories= + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories'; + + + 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}) + ); + + &startGradeScreen($r,'quick'); + + $r->rflush(); + +# my $uname='korte'; +# my $udom='gerd'; + + my $uname; + my $udom; + + my ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)= + &getData($showPoints,$uname,$udom); + + if ($showCategories) { + &outputCategories($r,$showPoints,$notshowTotals, + $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted); + } else { + &outputTable($r,$showPoints,$notshowTotals, + $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted); } + &endGradeScreen($r); + return OK; - # Keep this hash in sync with %statusIconMap in lonnavmaps; they - # should match color/icon - my $res = $navmap->firstResource(); # temp resource to access constants +} + +sub startGradeScreen { + my ($r,$mode)=@_; - if (!defined($navmap)) { - my $requrl = $r->uri; - $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; - return HTTP_NOT_ACCEPTABLE; - } - - # Header - $r->print(&Apache::loncommon::bodytag('Quick Score Display','', - '')); - - $r->print(<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 a detailed -score sheet.

-HEADER + my $showPoints = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard'; + my $notshowSPRSlink = + (($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'external') + || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals') + || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories')); + my $notshowTotals= + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'; + my $showCategories= + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories'; + + my $allowed_to_view = &Apache::lonnet::allowed('vgr',$env{'request.course.id'}); + my $allowed_to_edit = &Apache::lonnet::allowed('mgr',$env{'request.course.id'}); + + 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); + push(@notes,&mt('Students will see points based on categories.')) if ($showCategories); + push(@notes, &Apache::lonhtmlcommon::coursepreflink(&mt('Grade display settings'),'grading')); + $r->print(&Apache::loncommon::head_subbox(join('  ',@notes))); + } - $navmap->init(); - # End navmap using boilerplate + $r->print("\n".''."\n"); + $r->print('
'); +} + +sub endGradeScreen { + my ($r)=@_; + $r->print('
'); +} + + +sub getData { + + my ($showPoints,$uname,$udom)=@_; + + # Create the nav map + my $navmap = Apache::lonnavmaps::navmap->new($uname,$udom); + + my $res = $navmap->firstResource(); # temp resource to access constants my $iterator = $navmap->getIterator(undef, undef, undef, 1); my $depth = 1; @@ -111,8 +191,14 @@ HEADER # 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 ) { @@ -123,87 +209,162 @@ HEADER { # 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); - if ($status != $curRes->OPEN_LATER) { - $totalPossible++; + my $completionStatus = $curRes->getCompletionStatus($part); + my $dateStatus = $curRes->getDateStatus($part); + + if ($completionStatus == $curRes->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 ((($curRes->problemstatus($part) eq 'no') || + ($curRes->problemstatus($part) eq 'no_feedback_ever')) && + ($dateStatus != $curRes->ANSWER_OPEN)) { + my $status = $curRes->simpleStatus($part); + if ($status == $curRes->ATTEMPTED) { + $partsAttempted += $curRes->weight($part); + $totalAttempted += $partsAttempted; + } + } else { + $score = &Apache::grades::compute_points($curRes->weight($part), $curRes->awarded($part)); + } + $partsRight += $score; + $totalRight += $score; + $partsCount += $curRes->weight($part); + + if ($curRes->opendate($part) < $now) { + $totalPossible += $curRes->weight($part); + } + $totalParts += $curRes->weight($part); + } 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++; + } + + my $dateStatus = $curRes->getDateStatus($part); + $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 ($r,$showPoints,$notshowTotals, + $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()); + } } } @@ -211,45 +372,320 @@ HEADER } # 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()); } - my $maxHelpLink = Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct"); +# +# show totals (if applicable), close table +# + if ($showPoints) { + my $maxHelpLink = &Apache::loncommon::help_open_topic("Quick_Grades_Possibly_Correct"); - $r->print("\n\n"); + $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()); + } + $r->print(&Apache::loncommon::end_data_table() + .&Apache::loncommon::end_page()); - $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
Total Parts Correct: $totalRight
"); - $r->print("Max Possible To Date $maxHelpLink: $totalPossible
"); - $r->print("Total Parts In Course: $totalParts
'.$totaltitle.': '.$totalRight.'
'); + $r->print(&mt('Max Possible To Date')." $maxHelpLink: $totalPossible
"); + $title = $showPoints ? "Points" : "Parts"; + $r->print(&mt("Total $title In Course").': '.$totalParts.'
"); +} - $navmap->untieHashes(); +# +# === Outputting category-based grades. +# +# $category{'order'}: output order of categories by id +# $category{'all'}: complete list of all categories +# $category{$id.'_name'}: display-name of category +# - return OK; +sub outputCategories { + + my ($r,$showPoints,$notshowTotals, + $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=@_; +# Take care of storing and retrieving categories + + my $cangrade=&Apache::lonnet::allowed('mgr'); + + my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my %categories=(); +# Loading old categories + %categories=&Apache::lonnet::dump('grading_categories',$cdom,$cnum); +# Storing + if (($cangrade) && (($env{'form.storechanges'}) || ($env{'form.storemove'} ne ''))) { +# Process the changes + %categories=&process_category_edits($r,$cangrade,%categories); +# Actually store + &Apache::lonnet::logthis("Storing ".$categories{'order'}); + &Apache::lonnet::put('grading_categories',\%categories,$cdom,$cnum); + } +# new categories loaded now +# Form only generated if user can change the grading categories + if ($cangrade) { + $r->print('
'); + } +# + &output_category_table($r,$cangrade,$navmap,%categories); +# + if ($cangrade) { + $r->print(''. + '
'); + } +} + +# +# Process editing commands, update category hash +# + +sub process_category_edits { + my ($r,$cangrade,%categories)=@_; + unless ($cangrade) { return %categories; } + my $cmd=$env{'form.cmd'}; + if ($cmd eq 'createnewcat') { + %categories=&make_new_category($r,$cangrade,undef,%categories); + } + if ($cmd=~/^delcat\_(.+)$/) { + my $id=$1; + %categories=&del_category($id,$cangrade,%categories); + } +# +# Business logic here +# + return %categories; +} + +# +# Output the table +# + +sub output_category_table { + my ($r,$cangrade,$navmaps,%categories)=@_; + my $sum=0; + my $total=0; + $r->print(&Apache::loncommon::start_data_table()); +# + &output_category_table_header($r,$cangrade); +# + my @order=split(/\,/,$categories{'order'}); +# + my $maxpos=$#order; + for (my $i=0;$i<=$maxpos;$i++) { + my ($value,$weight)=&output_and_calc_category($r,$cangrade,$navmaps,$order[$i],$i,$maxpos,%categories); + $sum+=$value*$weight; + $total+=$weight; + } +# + &bottom_line_category($r,$cangrade,$sum,$total); +# + $r->print(&Apache::loncommon::end_data_table()); + return $sum; +} + +sub output_category_table_header { + my ($r,$cangrade)=@_; + $r->print(&Apache::loncommon::start_data_table_header_row()); + if ($cangrade) { + $r->print(''.&mt("Move").''.&mt('Action').''); + } + $r->print(''.&mt('Category').''. + ''.&mt('Contents').''. + ''.&mt('Calculation').''. + ''.&mt('Weight').''. + ''.&mt('Percent Overall').''); + $r->print(&Apache::loncommon::end_data_table_header_row()); +} + + +# +# Output one category to table +# + +sub output_and_calc_category { + my ($r,$cangrade,$navmaps,$id,$currentpos,$maxpos,%categories)=@_; + my $value=0; + my $weight=0; + my $iconpath = &Apache::loncommon::lonhttpdurl($r->dir_config('lonIconsURL') . "/"); + my %lt=&Apache::lonlocal::texthash( + 'up' => 'Move Up', + 'dw' => 'Move Down'); + $r->print("\n".&Apache::loncommon::start_data_table_row()); + + if ($cangrade) { + $r->print(< +
+ + $lt{ + +
+
+ + $lt{ + +
+ +ENDMOVE + $r->print("\n\n\n\n"); + $r->print(''.&mt('Delete').''); + + } + $r->print(&Apache::loncommon::end_data_table_row()."\n"); + return ($value,$weight); +} + +# +# Bottom line with grades +# + +sub bottom_line_category { + my ($r,$cangrade,$sum,$total)=@_; + $r->print(&Apache::loncommon::start_data_table_row()); + if ($cangrade) { + $r->print(''.&mt('Create New Category').''); + } + $r->print(''.&mt('Current:').$sum.'
'.&mt('Total:').$total.'
'); } +# +# Make one new category +# + +sub make_new_category { + my ($r,$cangrade,$ordernum,%categories)=@_; + unless ($cangrade) { return %categories; } +# Generate new ID + my $id=time.'_'.$$.'_'.rand(10000); +# Add new ID to list of all IDs ever created in this course + $categories{'all'}.=','.$id; + $categories{'all'}=~s/^\,//; +# Add new ID to ordered list of displayed and evaluated categories + $categories{'order'}.=','.$id; + $categories{'order'}=~s/^\,//; +# Move it into desired space + if (defined($ordernum)) { + %categories=&move_category($id,$cangrade,$ordernum,%categories); + } + return %categories; +} + +# +# Delete category +# + +sub del_category { + my ($id,$cangrade,%categories)=@_; + my @neworder=(); + foreach my $currentid (split(/\,/,$categories{'order'})) { + unless ($currentid eq $id) { + push(@neworder,$currentid); + } + } + $categories{'order'}=join(',',@neworder); + return %categories; +} + +# +# Move a category to a desired position n the display order +# + +sub move_category { + my ($id,$cangrade,$ordernum,%categories)=@_; + unless ($cangrade) { return %categories; } + my @order=split(/\,/,$categories{'order'}); +# Where is the index currently? + my $currentpos=¤t_pos_category($id,%categories); + if (defined($currentpos)) { + if ($currentpos<$ordernum) { +# This is moving to a higher index +# ....X1234.... +# ....1234X.... + for (my $i=$currentpos;$i<$ordernum;$i++) { + $order[$i]=$order[$i+1]; + } + $order[$ordernum]=$id; + } + if ($currentpos>$ordernum) { +# This is moving to a lower index +# ....1234X.... +# ....X1234.... + for (my $i=$currentpos;$i>$ordernum;$i--) { + $order[$i]=$order[$i-1]; + } + $order[$ordernum]=$id; + } + } + $categories{'order'}=join(',',@order); + return %categories; +} + +# +# Find current postion of a category in the order +# + +sub current_pos_category { + my ($id,%categories)=@_; + my @order=split(/\,/,$categories{'order'}); + for (my $i=0;$i<=$#order;$i++) { + if ($order[$i] eq $id) { return $i; } + } +# not found + return undef; +} + +# +# Set name of a category +# +sub set_category_name { + my ($canedit,$id,$name,%categories)=@_; + unless ($canedit) { return %categories; } + $categories{$id.'_name'}=$name; + return %categories; +} + +# +# === end category-related +# +# # Pass this two refs to arrays for the start and end color, and a number # from 0 to 1 for how much of the latter you want to mix in. It will # return a string ready to show ("#FFC309"); + sub mixColors { my $start = shift; 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; }