--- loncom/interface/lonquickgrades.pm 2011/06/03 01:07:22 1.100 +++ loncom/interface/lonquickgrades.pm 2022/10/19 00:03:10 1.123 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Quick Student Grades Display # -# $Id: lonquickgrades.pm,v 1.100 2011/06/03 01:07:22 www Exp $ +# $Id: lonquickgrades.pm,v 1.123 2022/10/19 00:03:10 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -29,13 +29,31 @@ 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::loncoursedata; +use Apache::lonstudentassessment; +use Apache::lonuserstate; + +use Time::HiRes; +use Spreadsheet::WriteExcel; +use Spreadsheet::WriteExcel::Utility(); +# +# Excel data +# +my $excel_sheet; +my $excel_workbook; +my $filename; +my $format; +my $request_aborted; +my $header_row; +my $cols_output; +my %prog_state; + sub handler { my $r = shift; @@ -58,31 +76,113 @@ sub real_handler { return OK; } - # Send header, don't cache this page - &Apache::loncommon::no_cache($r); - $r->send_http_header; - + my $cangrade=&Apache::lonnet::allowed('mgr'); my $showPoints = (($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'standard') || ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories')); - 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 $reinitresult; - 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}) - ); + 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').'.
'. + '
'; + %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); + } + } elsif ((&Apache::loncommon::course_type() eq 'Placement') && + (!$env{'request.role.adv'})) { + my $furl = &Apache::lonpageflip::first_accessible_resource(); + &Apache::loncommon::content_type($r,'text/html'); + $r->header_out(Location => $furl); + return REDIRECT; + } + if (($reinitresult eq 'supp') || ($reinitresult eq 'both')) { + my ($supplemental,$refs_updated) = &Apache::lonnet::get_supplemental($cnum,$cdom); + 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; + &startpage($r,$showPoints); + } + $r->rflush(); &startGradeScreen($r,'quick'); - my $cangrade=&Apache::lonnet::allowed('mgr'); # # Pick student # @@ -90,16 +190,53 @@ sub real_handler { my $udom; my $stdid; if ($cangrade) { + $r->print("

".&mt("Download Multiple")."

". + ''."\n". + ''. + ''. + ''. + ''. + ''. + ''."\n". + ''."\n". + '
'.&mt('Sections').''. + &Apache::loncommon::help_open_topic("Chart_Sections"). + ''.&mt('Groups').''. + ''.&mt('Student Data').''. + &Apache::loncommon::help_open_topic("Chart_Student_Data"). + ''.&mt('Access Status').''. + &Apache::loncommon::help_open_topic("Chart_Enrollment_Status"). + ''.&mt('Output Format').''. + &Apache::loncommon::help_open_topic("Chart_Output_Formats"). + ' 
'."\n". + &Apache::lonstatistics::SectionSelect('Section','multiple',5). + ''. + &Apache::lonstatistics::GroupSelect('Group','multiple',5). + ''. + &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',5,undef). + ''."\n". + &Apache::lonhtmlcommon::StatusOptions(undef,undef,5). + ''."\n". + &Apache::lonstudentassessment::CreateAndParseOutputSelector(). + ''. + ''. + '
'."\n" + ); + $r->print("

".&mt("Display Individual")."

"); 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))[1]; + $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'); @@ -107,28 +244,64 @@ sub real_handler { $r->print(&mt('For User [_1] or Student/Employee ID [_2] at Domain [_3]' ,'' ,' ' - ,$chooseopt).'
'. - '

'); + ,$chooseopt). + '  

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

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

'); } } $r->rflush(); - my ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)= - &getData($showPoints,$uname,$udom); + my $notshowTotals= + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'; + my $showCategories= + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories'; + + 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); + if (ref($navmap)) { + 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); + } } else { - &outputTable($r,$showPoints,$notshowTotals, - $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted); + if ($cangrade) { $r->print("\n
\n"); } + my $requrl = $r->uri; + $env{'user.error.msg'} = "$requrl:bre:0:0:Navmap initialization failed."; + return HTTP_NOT_ACCEPTABLE; } 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; } sub getStudentCatGrade { @@ -159,6 +332,14 @@ sub getAllStudentData { } } +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,$mode)=@_; @@ -169,13 +350,24 @@ sub startGradeScreen { (($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= + my $notshowTotals = $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'externalnototals'; - my $showCategories= + my $showSPRSlink = + $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'spreadsheet'; + my $showCategories = $env{'course.'.$env{'request.course.id'}.'.grading'} eq 'categories'; + + 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'}"); + } - my $allowed_to_view = &Apache::lonnet::allowed('vgr',$env{'request.course.id'}); - my $allowed_to_edit = &Apache::lonnet::allowed('mgr',$env{'request.course.id'}); + 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'}"); + } if ($allowed_to_view) { my @notes; @@ -183,6 +375,7 @@ sub startGradeScreen { 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,&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))); } @@ -202,7 +395,7 @@ sub startGradeScreen { &mt('Statistics and Reports').''); $r->print("\n".''. - &mt('Assessment Overview Chart').''); + &mt('Assessment Chart').''); } if ($allowed_to_edit) { @@ -211,7 +404,7 @@ sub startGradeScreen { if ($env{'form.symb'}) { $r->print("\n".'    '. + '&command=gradingmenu">    '. &mt('Problem Grading').'    '); } @@ -221,11 +414,74 @@ sub startGradeScreen { } sub endGradeScreen { - my ($r)=@_; - $r->print(''.&Apache::loncommon::end_page()); + my ($r)=@_; + $r->print(''.&Apache::loncommon::end_page()); + return; +} + +# ----------- + + +sub excel_cleanup { + undef ($excel_sheet); + undef ($excel_workbook); + undef ($filename); + undef ($format); } +sub excel_initialize { + my ($r) = @_; + + &excel_cleanup(); + + # Create sheet + ($excel_workbook,$filename,$format)= + &Apache::loncommon::create_workbook($r); + return if (! defined($excel_workbook)); + # + # Add a worksheet + my $sheetname = $env{'course.'.$env{'request.course.id'}.'.description'}; + $sheetname = &Apache::loncommon::clean_excel_name($sheetname); + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Put the course description in the header + $excel_sheet->write($header_row,$cols_output++, + $env{'course.'.$env{'request.course.id'}.'.description'}, + $format->{'h1'}); +} + +sub excel_finish { + my ($r) = @_; + if ($request_aborted || ! defined($excel_sheet)) { + &excel_cleanup(); + return; + } + # + # Write the excel file + $excel_workbook->close(); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their excel file + $r->print('
'. + ''.&mt('Your Excel spreadsheet').''."\n"); + $r->rflush(); + &excel_cleanup(); + return; +} + + +# +# CSV data +# +# ----------- + +# +# Go through the complete course and collect data +# + sub getData { my ($showPoints,$uname,$udom)=@_; @@ -233,13 +489,18 @@ sub getData { # 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 $deeplinkcond = 1; + my $iterator = $navmap->getIterator(undef, undef, undef, 1, undef, undef, $deeplinkcond); 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 @@ -261,8 +522,17 @@ sub getData { while ( $depth > 0 ) { if ($curRes == $iterator->BEGIN_MAP()) {$depth++;} if ($curRes == $iterator->END_MAP()) { $depth--; } - - if (ref($curRes) && $curRes->is_problem() && !$curRes->randomout) + my ($deeplink,$nodeeplinkcheck,$symb); + $nodeeplinkcheck = 1; + if (ref($curRes)) { + $symb = $curRes->symb(); + $deeplink = $curRes->deeplink('quickgrades'); + if ($deeplink eq 'absent') { + $nodeeplinkcheck = 0; + } + } + if (ref($curRes) && $curRes->is_gradable() && !$curRes->randomout && + ($nodeeplinkcheck)) { # Get number of correct, incorrect parts my $parts = $curRes->parts(); @@ -352,7 +622,8 @@ sub getData { } $curRes = $iterator->next(); } - return ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted); + return ($navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted, + $topLevelParts,$topLevelRight,$topLevelAttempted); } # @@ -361,8 +632,8 @@ sub getData { sub outputTable { - my ($r,$showPoints,$notshowTotals, - $navmap,$totalParts,$totalPossible,$totalRight,$totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=@_; + my ($r,$showPoints,$notshowTotals,$navmap,$totalParts,$totalPossible,$totalRight, + $totalAttempted,$topLevelParts,$topLevelRight,$topLevelAttempted)=@_; my @start = (255, 255, 192); my @end = (0, 192, 0); @@ -383,7 +654,8 @@ sub outputTable { # Output of folder scores # - my $iterator = $navmap->getIterator(undef, undef, undef, 1); + my $deeplinkcond = 1; + my $iterator = $navmap->getIterator(undef, undef, undef, 1, undef, undef, $deeplinkcond); my $depth = 1; $iterator->next(); # ignore first BEGIN_MAP my $curRes = $iterator->next(); @@ -460,6 +732,7 @@ sub outputTable { } $r->print(&Apache::loncommon::end_data_table()); + return; } # @@ -513,7 +786,8 @@ sub dumpdata { # Run through the map and get all data - my $iterator = $navmap->getIterator(undef, undef, undef, 1); + my $deeplinkcond = 1; + my $iterator = $navmap->getIterator(undef, undef, undef, 1, undef, undef, $deeplinkcond); my $depth = 1; $iterator->next(); # ignore first BEGIN_MAP my $curRes = $iterator->next();