--- loncom/interface/loncoursequeueadmin.pm 2009/12/20 02:05:57 1.12.2.3 +++ loncom/interface/loncoursequeueadmin.pm 2011/03/06 21:17:15 1.26 @@ -1,7 +1,7 @@ # The LearningOnline Network -# Utilities to administer domain course requests and course self-enroll requests +# Utilities to administer domain course requests and course self-enroll requests # -# $Id: loncoursequeueadmin.pm,v 1.12.2.3 2009/12/20 02:05:57 raeburn Exp $ +# $Id: loncoursequeueadmin.pm,v 1.26 2011/03/06 21:17:15 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,13 +27,17 @@ # ### +=pod + =head1 NAME Apache::loncoursequeueadmin.pm =head1 SYNOPSIS -Adminitsration utilities used by domain coordinators for queued course creation requests, and by course coordinators for queued self-enrollment requests. +Utilities used by domain coordinators to administer queued course creation requests, +and by course coordinators for queued self-enrollment requests, and by general +users to display their queued self-enrollment requests. This is part of the LearningOnline Network with CAPA project described at http://www.lon-capa.org. @@ -46,10 +50,26 @@ described at http://www.lon-capa.org. =item display_queued_requests() +=item build_queue_display() + =item update_request_queue() =item get_student_counts() +=item course_creation() + +=item build_batchcreatehash() + +=item can_clone_course() + +=item get_processtype() + +=item queued_selfenrollment() + +=item update_coursereq_status() + +=item process_official_reqs() + =back =cut @@ -57,13 +77,12 @@ described at http://www.lon-capa.org. package Apache::loncoursequeueadmin; use strict; -use Apache::Constants qw(:common :http); use Apache::lonnet; use Apache::loncommon; use Apache::lonmsg; use Apache::lonlocal; use Apache::lonuserutils; -use LONCAPA; +use LONCAPA qw(:DEFAULT :match); sub send_selfserve_notification { my ($notifylist,$textstr,$cid,$contextdesc,$timestamp,$context,$sender, @@ -71,8 +90,8 @@ sub send_selfserve_notification { # FIXME locallocaltime needs to be able to take $sender_lh as an argument # so this can be localized to the recipients date display format/time zone $timestamp =&Apache::lonlocal::locallocaltime($timestamp); - my $msgcc; - my ($rawsubj,@rawmsg,$subject,$message,$reviewer,$msgtxt); + my ($msgcc,$rawsubj,@rawmsg,$subject,$message,$reviewer,$msgtxt); + my ($senderuname,$senderudom) = split(':',$sender); if ($context eq 'coursemanagers') { $rawsubj = 'Self-enrollment requests processed'; push(@rawmsg,{ @@ -119,6 +138,15 @@ sub send_selfserve_notification { if (ref($textstr) eq 'ARRAY') { push(@rawmsg,@{$textstr}); } + } elsif ($context eq 'pendingrequestor') { + if ($crstype eq 'Community') { + $rawsubj = 'Community request'; + } else { + $rawsubj = 'Processed course request'; + } + if (ref($textstr) eq 'ARRAY') { + push(@rawmsg,@{$textstr}); + } } elsif ($context eq 'coursereq') { if ($crstype eq 'community') { $rawsubj = 'Community request to review'; @@ -194,7 +222,7 @@ sub send_selfserve_notification { $message .= &Apache::lonlocal::mt_user($sender_lh,$item->{mt},@{$item->{args}})."\n"; } } - &Apache::lonmsg::process_sent_mail($subject,'',$numsent,$stamp,$uname,$udom,$msgcount,$cid,$$,$message,\@recusers,\@recudoms); + &Apache::lonmsg::process_sent_mail($subject,'',$numsent,$stamp,$uname,$udom,$msgcount,$cid,$$,$message,\@recusers,\@recudoms,undef,undef,undef,undef,$senderuname,$senderudom); my ($recipid,$recipstatus) = &Apache::lonmsg::store_recipients($subject,$uname,$udom,\%reciphash); my $status; foreach my $recip (sort(keys(%{$msgcc}))) { @@ -240,34 +268,22 @@ sub display_queued_requests { } else { $formaction = '/adm/createcourse'; $namespace = 'courserequestqueue'; - %requesthash = &Apache::lonnet::dump_dom($namespace,$dom,'_approval'); - $nextelement = ''; + my $disposition = 'approval'; + my $nextphase = 'requestchange'; + if ($context eq 'pending') { + $disposition = 'pending'; + $nextphase = 'requestvalidation'; + } + %requesthash = &Apache::lonnet::dump_dom($namespace,$dom,'_'.$disposition); + $nextelement = ''; } - my ($output,%queue_by_date,%crstypes); + my ($output,%queue_by_date); if (keys(%requesthash) > 0) { $output = '
'."\n". ''."\n". - $nextelement."\n". - &Apache::loncommon::start_data_table(). - &Apache::loncommon::start_data_table_header_row(). - ''.&mt('Action').''. - ''.&mt('Requestor').''; - if ($context eq 'course') { - $output .= ''.&mt('Section').''. - ''.&mt('Date requested').''; - } else { - %crstypes = &Apache::lonlocal::texthash ( - official => 'Official course', - unofficial => 'Unofficial course', - community => 'Community', - ); - $output .= ''.&mt('Type').''. - ''.&mt('Date requested').''. - ''.&mt('Details').''; - } - $output .= &Apache::loncommon::end_data_table_header_row(); + $nextelement."\n"; foreach my $item (keys(%requesthash)) { - my ($timestamp,$entry); + my ($timestamp,$entry,$pending); if ($context eq 'course') { ($timestamp, my $usec) = split(/:/,$requesthash{$item}); $entry = $item.':'.$usec; @@ -276,98 +292,175 @@ sub display_queued_requests { if (ref($requesthash{$item}) eq 'HASH') { my ($cnum,$disposition) = split('_',$item); $entry = $cnum.':'.$requesthash{$item}{'ownername'}.':'. - $requesthash{$item}{'ownerdom'}.':'. - $requesthash{$item}{'crstype'}.':'. - $requesthash{$item}{'description'}; + $requesthash{$item}{'ownerdom'}.':'; + if ($context eq 'pending') { + $entry .= $requesthash{$item}{'instcode'}; + } else { + $entry .= $requesthash{$item}{'crstype'}; + } + $entry .= ':'.$requesthash{$item}{'description'}; } } if ($entry ne '') { - if (exists($queue_by_date{$timestamp})) { - if (ref($queue_by_date{$timestamp}) eq 'ARRAY') { - push(@{$queue_by_date{$timestamp}},$entry); - } + if (ref($queue_by_date{$timestamp}) eq 'ARRAY') { + push(@{$queue_by_date{$timestamp}},$entry); } else { - @{$queue_by_date{$timestamp}} = ($entry); + $queue_by_date{$timestamp} = [$entry]; } } } - my @sortedtimes = sort {$a <=> $b} (keys(%queue_by_date)); - my $count = 0; - foreach my $item (@sortedtimes) { - if (ref($queue_by_date{$item}) eq 'ARRAY') { - foreach my $request (sort(@{$queue_by_date{$item}})) { - my ($row,$approve,$reject,$showtime,$showsec,$namelink, - $detailslink,$crstype); - $showtime = &Apache::lonlocal::locallocaltime($item); - if ($context eq 'course') { - my ($puname,$pudom,$pusec) = split(/:/,$request); - $approve = $count.':'.$puname.':'.$pudom.':'.$pusec; - $reject = $puname.':'.$pudom; - $showsec = $pusec; - if ($showsec eq '') { - $showsec = &mt('none'); - } - $namelink = &Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($puname,$pudom), - $puname,$pudom); + if (keys(%queue_by_date) > 0) { + if ($context eq 'course') { + $output .= '

'.&mt('Self-enrollment requests queued pending approval by a Coordinator').'

'; + } elsif ($context eq 'pending') { + $output .= '

'.&mt('Requests for official courses queued pending validation').'

'. + '

'.&mt('Requests are validated against institutional data to confirm that the requestor is an instructor of record.').'
'. + &mt('Validation is attempted when the request is submitted.').' '.&mt('If unvalidated, the request will be held in a queue.').' '.&mt('Validation of pending requests is automatically repeated daily.').'

'; + } else { + $output .= '

'.&mt('Course/Community requests queued pending approval by a Domain Coordinator').'

'; + } + $output .= &build_queue_display($dom,$context,\%queue_by_date). + ''; + } else { + $output .= '
'; + if ($context eq 'course') { + $output .= &mt('There are currently no enrollment requests awaiting approval.'); + } elsif ($context eq 'pending') { + $output .= &mt('There are currently no requests for official courses awaiting validation.'); + } elsif ($context eq 'domain') { + $output .= &mt('There are currently no course or community requests awaiting approval.'); + } + $output .= '
'; + } + if ($context eq 'pending') { + $output .= '

'."\n". + '

'.&mt('Any course/community requests which are successfully validated will be created immediately.').' '.&mt('Unvalidated requests will be listed for manual approval/rejection.').'

'; + } else { + $output .= '
'; + } + $output .= '
'; + } else { + $output .= '
'; + if ($context eq 'course') { + $output .= &mt('There are currently no enrollment requests awaiting approval.'); + } elsif ($context eq 'pending') { + $output .= &mt('There are currently no requests for official courses awaiting validation.'); + } else { + $output .= &mt('There are currently no course or community requests awaiting approval.'); + } + $output .= '
'; + } + return $output; +} +sub build_queue_display { + my ($dom,$context,$queue) = @_; + return unless (ref($queue) eq 'HASH'); + my %crstypes; + my $output = &Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_header_row(); + unless ($context eq 'pending') { + $output .= ''.&mt('Action').''; + } + $output .= ''.&mt('Requestor').''; + if ($context eq 'course') { + $output .= ''.&mt('Section').''. + ''.&mt('Date requested').''; + } elsif ($context eq 'pending' || $context eq 'stillpending') { + $output .= ''.&mt('Institutional code').''. + ''.&mt('Date requested').''. + ''.&mt('Details').''; + } else { + %crstypes = &Apache::lonlocal::texthash ( + official => 'Official course', + unofficial => 'Unofficial course', + community => 'Community', + ); + $output .= ''.&mt('Type').''. + ''.&mt('Date requested').''. + ''.&mt('Details').''; + } + $output .= &Apache::loncommon::end_data_table_header_row(); + my @sortedtimes = sort {$a <=> $b} (keys(%{$queue})); + my $count = 0; + foreach my $item (@sortedtimes) { + if (ref($queue->{$item}) eq 'ARRAY') { + foreach my $request (sort(@{$queue->{$item}})) { + my ($row,$approve,$reject,$showtime,$showsec,$namelink, + $detailslink,$crstype,$instcode); + $showtime = &Apache::lonlocal::locallocaltime($item); + if ($context eq 'course') { + my ($puname,$pudom,$pusec) = split(/:/,$request); + $approve = $count.':'.$puname.':'.$pudom.':'.$pusec; + $reject = $puname.':'.$pudom; + $showsec = $pusec; + if ($showsec eq '') { + $showsec = &mt('none'); + } + $namelink = &Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($puname,$pudom), + $puname,$pudom); + } else { + my ($cnum,$ownername,$ownerdom,$type,$cdesc); + my $queue = 'approval'; + if ($context eq 'pending' || $context eq 'stillpending') { + ($cnum,$ownername,$ownerdom,$instcode,$cdesc)=split(/:/,$request,5); + $queue = 'pending'; } else { - my ($cnum,$ownername,$ownerdom,$type,$cdesc)=split(/:/,$request,5); - $detailslink=''.$cdesc.''; + ($cnum,$ownername,$ownerdom,$type,$cdesc)=split(/:/,$request,5); $crstype = $type; if (defined($crstypes{$type})) { $crstype = $crstypes{$type}; } - $approve = $count.':'.$cnum; - $reject = $cnum; - $namelink = &Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($ownername,$ownerdom), - $ownername,$ownerdom); } + $detailslink=''.$cdesc.''; + $approve = $count.':'.$cnum; + $reject = $cnum; + $namelink = &Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($ownername,$ownerdom), + $ownername,$ownerdom); + } + unless ($context eq 'pending') { $row = '
'. '
'. - ''.$namelink.''."\n"; - if ($context eq 'course') { - $row .= ''.$showsec.''."\n". - ''.$showtime.''."\n"; - } else { - $row .= ''.$crstype.''."\n". - ''.$showtime.''."\n". - ''.$detailslink.''."\n"; - } - $output .= &Apache::loncommon::start_data_table_row()."\n". - $row. - &Apache::loncommon::end_data_table_row()."\n"; - $count ++; + ''.&mt('Reject').'
'; } + $row .= ''.$namelink.''."\n"; + if ($context eq 'course') { + $row .= ''.$showsec.''."\n". + ''.$showtime.''."\n"; + } else { + if ($context eq 'pending' || $context eq 'stillpending') { + $row .= ''.$instcode.''."\n"; + } else { + $row .= ''.$crstype.''."\n"; + } + $row .= ''.$showtime.''."\n". + ''.$detailslink.''."\n"; + } + $output .= &Apache::loncommon::start_data_table_row()."\n". + $row. + &Apache::loncommon::end_data_table_row()."\n"; + $count ++; } } - $output .= &Apache::loncommon::end_data_table(). - ''; - } else { - if ($context eq 'course') { - $output .= &mt('There are currently no enrollment requests.'); - } else { - $output .= &mt('There are currently no course or community requests awaiting approval.'); - } } + $output .= &Apache::loncommon::end_data_table(); return $output; } sub update_request_queue { my ($context,$cdom,$cnum,$coursedesc) = @_; my ($output,$access_start,$access_end,$limit,$cap,$notifylist,$namespace, - $stucounts,$idx,$classlist,%requesthash,$cid,$hostname,$protocol, - $domdesc,$now,$sender,$approvedmsg,$rejectedmsg,$beneficiary, + $stucounts,$idx,$classlist,%requesthash,$cid,$domdesc,$now, + $sender,$approvedmsg,$rejectedmsg,$beneficiary, @existing,@missingreq,@invalidusers,@limitexceeded,@completed, - @processing_errors,@warn_approves,@warn_rejects,@approvals, + @processing_errors,@warn_approves,@warn_rejects,@approvals,@warn_dels, @rejections,@rejectionerrors,@nopermissions,%courseroles, - %communityroles,%domdefs,%approvalmsg,%rejectionmsg,$crstype, - @warn_coursereqs); + %communityroles,%domdefs,%approvalmsg,%rejectionmsg,$crstype,$queue,$firsturl); @approvals = &Apache::loncommon::get_env_multiple('form.approvereq'); @rejections = &Apache::loncommon::get_env_multiple('form.rejectreq'); $now = time; @@ -377,10 +470,7 @@ sub update_request_queue { $beneficiary = 'enroller'; $cid = $env{'request.course.id'}; $crstype = lc(&Apache::loncommon::course_type()); - my $chome = &Apache::lonnet::homeserver($cnum,$cdom); - $hostname = &Apache::lonnet::hostname($chome); - $protocol = $Apache::lonnet::protocol{$chome}; - $protocol = 'http' if ($protocol ne 'https'); + $firsturl = &course_portal_url($cnum,$cdom); %requesthash = &Apache::lonnet::dump($namespace,$cdom,$cnum); $access_start = $env{'course.'.$cid.'.internal.selfenroll_start_access'}; $access_end = $env{'course.'.$cid.'.internal.selfenroll_end_access'}; @@ -393,7 +483,7 @@ sub update_request_queue { }, { mt => 'Visit [_1], to log-in and access the course', - args => [$protocol.'://'.$hostname], + args => [$firsturl], }]; $rejectedmsg = [{ mt => 'Your request for enrollment has not been approved.', @@ -402,11 +492,12 @@ sub update_request_queue { $domdesc = &Apache::lonnet::domain($cdom); $namespace = 'courserequestqueue'; $beneficiary = 'courserequestor'; - %requesthash = &Apache::lonnet::dump_dom($namespace,$cdom,'_approval'); - my $chome = &Apache::lonnet::domain($cdom,'primary'); - $hostname = &Apache::lonnet::hostname($chome); - $protocol = $Apache::lonnet::protocol{$chome}; - $protocol = 'http' if ($protocol ne 'https'); + $queue = 'approval'; + if ($env{'form.queue'} eq 'pending') { + $queue = 'pending'; + } + %requesthash = &Apache::lonnet::dump_dom($namespace,$cdom,'_'.$queue); + $firsturl= &course_portal_url($cnum,$cdom); my %domconfig = &Apache::lonnet::get_dom('configuration',['requestcourses'],$cdom); if (ref($domconfig{'requestcourses'}) eq 'HASH') { if (ref($domconfig{'requestcourses'}{'notify'}) eq 'HASH') { @@ -419,7 +510,7 @@ sub update_request_queue { }, { mt => 'Visit [_1], to log-in and access the course', - args => [$protocol.'://'.$hostname], + args => [$firsturl], }]; $rejectionmsg{'course'} = [{ @@ -432,7 +523,7 @@ sub update_request_queue { }, { mt => 'Visit [_1], to log-in and access the community', - args => [$protocol.'://'.$hostname], + args => [$firsturl], }]; $rejectionmsg{'community'} = @@ -456,10 +547,6 @@ sub update_request_queue { my $uhome = &Apache::lonnet::homeserver($uname,$udom); if ($uhome ne 'no_host') { if (exists($requesthash{$uname.':'.$udom})) { - if ($cdom eq 'gci' && $cnum eq '9615072b469884921gcil1') { - my $enresult = &enable_gci_submission($uname,$udom, - $access_start,$access_end); - } if (exists($classlist->{$uname.':'.$udom})) { if (ref($classlist->{$uname.':'.$udom}) eq 'ARRAY') { if (($classlist->{$uname.':'.$udom}->[$idx->{'status'}] eq 'Active') || @@ -492,7 +579,8 @@ sub update_request_queue { $stucounts->{'allstudents'} ++; $stucounts->{'selfenrolled'} ++; &send_selfserve_notification($uname.':'.$udom,$approvedmsg, - $cid,$coursedesc,$now,$beneficiary,$sender,undef,undef,$crstype); + $cid,$coursedesc,$now,$beneficiary,$sender, + undef,undef,$crstype); my %userrequest = ( $cdom.'_'.$cnum => { timestamp => $now, @@ -505,15 +593,6 @@ sub update_request_queue { &Apache::lonnet::put($namespace,\%userrequest,$udom,$uname); if ($userresult ne 'ok') { push(@warn_approves,$uname.':'.$udom); - } elsif ($udom eq 'gci') { - my %changehash = ( - 'reqcrsotherdom.unofficial' => 'gcitest:autolimit=', - ); - my $reqresult = &Apache::lonnet::put('environment',\%changehash, - $udom,$uname); - if ($reqresult ne 'ok') { - push(@warn_coursereqs,$uname.':'.$udom); - } } } else { push(@processing_errors,$uname.':'.$udom); @@ -524,12 +603,12 @@ sub update_request_queue { } } else { my ($num,$cnum) = split(':',$item); - if (ref($requesthash{$cnum.'_approval'}) eq 'HASH') { + if (ref($requesthash{$cnum.'_'.$queue}) eq 'HASH') { if (&Apache::lonnet::homeserver($cnum,$cdom) eq 'no_host') { - my $ownername = $requesthash{$cnum.'_approval'}{'ownername'}; - my $ownerdom = $requesthash{$cnum.'_approval'}{'ownerdom'}; - $crstype = $requesthash{$cnum.'_approval'}{'crstype'}; - my $coursedesc = $requesthash{$cnum.'_approval'}{'description'}; + my $ownername = $requesthash{$cnum.'_'.$queue}{'ownername'}; + my $ownerdom = $requesthash{$cnum.'_'.$queue}{'ownerdom'}; + $crstype = $requesthash{$cnum.'_'.$queue}{'crstype'}; + my $coursedesc = $requesthash{$cnum.'_'.$queue}{'description'}; my $longroles = \%courseroles; if ($crstype eq 'community') { $longroles = \%communityroles; @@ -555,7 +634,7 @@ sub update_request_queue { &Apache::lonnet::restore($requestkey,'courserequests', $ownerdom,$ownername); if ((ref($history{'details'}) eq 'HASH') && - ($history{'disposition'} eq 'approval')) { + ($history{'disposition'} eq $queue)) { my ($logmsg,$newusermsg,$addresult,$enrollcount,$response,$keysmsg); my $result = &course_creation($cdom,$cnum,$context,$history{'details'},\$logmsg, \$newusermsg,\$addresult,\$enrollcount, @@ -567,8 +646,13 @@ sub update_request_queue { $approvedmsg = $approvalmsg{'course'}; } push(@completed,$cnum); - &send_selfserve_notification($ownername.':'.$ownerdom,$approvedmsg, - $cid,$coursedesc,$now,$beneficiary,$sender,undef,undef,$crstype); + + unless (&Apache::lonnet::del_dom($namespace,[$cnum.'_'.$queue],$cdom) eq 'ok') { + push(@warn_dels,$cnum); + } + &send_selfserve_notification($ownername.':'.$ownerdom, + $approvedmsg,$cid,$coursedesc,$now, + $beneficiary,$sender,undef,undef,$crstype); my %reqhash = ( reqtime => $history{'reqtime'}, crstype => $history{'crstype'}, @@ -614,14 +698,15 @@ sub update_request_queue { } my @changes = (@completed,@rejections); if ($context eq 'domain') { - @changes = map {$_.'_approval'} (@changes); + @changes = map {$_.'_'.$queue} (@changes); } if (@rejections) { foreach my $item (@rejections) { if ($context eq 'course') { my $user = $item; &send_selfserve_notification($user,$rejectedmsg,$cid,$coursedesc, - $now,$beneficiary,$sender,undef,undef,$crstype); + $now,$beneficiary,$sender,undef,undef, + $crstype); my ($uname,$udom) = split(/:/,$user); my %userrequest = ( $cdom.'_'.$cnum => { @@ -637,13 +722,13 @@ sub update_request_queue { } } else { my $cnum = $item; - if (ref($requesthash{$cnum.'_approval'}) eq 'HASH') { + if (ref($requesthash{$cnum.'_'.$queue}) eq 'HASH') { if (&Apache::lonnet::homeserver($cnum,$cdom) eq 'no_host') { my $requestkey = $cdom.'_'.$cnum; - my $ownername = $requesthash{$cnum.'_approval'}{'ownername'}; - my $ownerdom = $requesthash{$cnum.'_approval'}{'ownerdom'}; - my $coursedesc = $requesthash{$cnum.'_approval'}{'description'}; - $crstype = $requesthash{$cnum.'_approval'}{'crstype'}; + my $ownername = $requesthash{$cnum.'_'.$queue}{'ownername'}; + my $ownerdom = $requesthash{$cnum.'_'.$queue}{'ownerdom'}; + my $coursedesc = $requesthash{$cnum.'_'.$queue}{'description'}; + $crstype = $requesthash{$cnum.'_'.$queue}{'crstype'}; if ($crstype eq 'community') { $rejectedmsg = $rejectionmsg{'community'}; } else { @@ -656,7 +741,7 @@ sub update_request_queue { &Apache::lonnet::restore($requestkey,'courserequests', $ownerdom,$ownername); if ((ref($history{'details'}) eq 'HASH') && - ($history{'disposition'} eq 'approval')) { + ($history{'disposition'} eq $queue)) { my %reqhash = ( reqtime => $history{'reqtime'}, crstype => $history{'crstype'}, @@ -681,6 +766,9 @@ sub update_request_queue { } else { push(@warn_rejects,$cnum); } + unless (&Apache::lonnet::del_dom($namespace,[$cnum.'_'.$queue],$cdom) eq 'ok') { + push(@warn_dels,$cnum); + } } else { push(@warn_rejects,$cnum); } @@ -741,8 +829,8 @@ sub update_request_queue { $output .= '

'.&mt('The following courses/communities were created:').'