# The LearningOnline Network
# Utilities to administer domain course requests and course self-enroll requests
#
# $Id: loncoursequeueadmin.pm,v 1.19 2010/02/21 23:38:51 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
###
=head1 NAME
Apache::loncoursequeueadmin.pm
=head1 SYNOPSIS
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.
=head1 SUBROUTINES
=over
=item send_selfserve_notification()
=item display_queued_requests()
=item update_request_queue()
=item get_student_counts()
=item course_creation()
=item build_batchcreatehash()
=item can_clone_course()
=item get_processtype()
=item queued_selfenrollment()
=back
=cut
package Apache::loncoursequeueadmin;
use strict;
use Apache::lonnet;
use Apache::loncommon;
use Apache::lonmsg;
use Apache::lonlocal;
use Apache::lonuserutils;
use LONCAPA qw(:DEFAULT :match);
sub send_selfserve_notification {
my ($notifylist,$textstr,$cid,$contextdesc,$timestamp,$context,$sender,
$approvedlist,$rejectedlist,$crstype) = @_;
# 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);
if ($context eq 'coursemanagers') {
$rawsubj = 'Self-enrollment requests processed';
push(@rawmsg,{
mt => 'Enrollment requests in the following course: [_1] have been processed.',
args => ["\n $contextdesc"],
});
} elsif ($context eq 'domainmanagers') {
$rawsubj = 'Course/Community requests reviewed';
push(@rawmsg,{
mt => 'Course/Community creation requests in the following domain: [_1] have been reviewed.',
args => ["\n $contextdesc"],
});
if (ref($textstr) eq 'ARRAY') {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'enroller') {
$rawsubj = 'Enrollment request';
if ($crstype eq 'community') {
$msgtxt = 'Your request for enrollment in the following community: [_1]requested on [_2]has been reviewed by a Coordinator.'
} else {
$msgtxt = 'Your request for enrollment in the following course: [_1]requested on [_2]has been reviewed by a Course Coordinator.';
}
push(@rawmsg,{
mt => $msgtxt,
args => ["\n ".$contextdesc.",\n",$timestamp.",\n"],
});
if (ref($textstr) eq 'ARRAY') {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'courserequestor') {
if ($crstype eq 'Community') {
$rawsubj = 'Community request';
$msgtxt = 'Your request for creation of the following community: [_1]requested on [_2]has been reviewed by a Domain Coordinator.';
} else {
$rawsubj = 'Course request';
$msgtxt = 'Your request for creation of the following course: [_1]requested on [_2]has been reviewed by a Domain Coordinator.';
}
push(@rawmsg,{
mt => $msgtxt,
args => ["\n".$contextdesc.",\n",$timestamp.",\n"],
});
if (ref($textstr) eq 'ARRAY') {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'coursereq') {
if ($crstype eq 'community') {
$rawsubj = 'Community request to review';
$msgtxt = 'Creation of the following community: [_1]was requested by [_2] on [_3].';
} else {
$rawsubj = 'Course request to review';
$msgtxt = 'Creation of the following course: [_1]was requested by [_2] on [_3].';
}
push(@rawmsg,{
mt => $msgtxt,
args => ["\n $contextdesc\n",$textstr,$timestamp],
},
{
mt =>'[_1]As Domain Coordinator, use: [_2]Main Menu -> Course and community creation -> Approve or reject requests[_3]to display a list of pending requests, which you can either approve or reject.',
args => ["\n","\n\n ","\n\n"],
});
} elsif ($context eq 'selfenrollreq') {
$rawsubj = 'Self-enrollment request';
if ($crstype eq 'community') {
$msgtxt = 'Enrollment in the following community: [_1] was requested by [_2] on [_3].'
} else {
$msgtxt = 'Enrollment in the following course: [_1] was requested by [_2] on [_3].'
}
push(@rawmsg,{
mt => $msgtxt,
args => ["\n $contextdesc\n",$textstr,$timestamp."\n"],
});
my $directions;
if ($crstype eq 'community') {
$directions = 'As Coordinator, use: [_1]Main Menu -> Manage Community Users -> Enrollment Requests[_2]to display a list of pending enrollment requests, which you can either approve or reject.';
} else {
$directions = 'As Course Coordinator, use: [_1]Main Menu -> Manage Course Users -> Enrollment Requests[_2]to display a list of pending enrollment requests, which you can either approve or reject.';
}
push(@rawmsg,
{
mt => $directions,
args => [" \n\n","\n"],
});
}
my @to_notify = split(/,/,$notifylist);
my $numsent = 0;
my @recusers;
my @recudoms;
foreach my $cc (@to_notify) {
my ($ccname,$ccdom) = split(/:/,$cc);
if (!exists($msgcc->{$ccname.':'.$ccdom})) {
push(@recusers,$ccname);
push(@recudoms,$ccdom);
$msgcc->{$ccname.':'.$ccdom}='';
$numsent ++;
}
}
my %reciphash = (
cc => $msgcc,
);
my ($uname,$udom);
if ($sender =~ /:/) {
($uname,$udom) = split(/:/,$sender);
} elsif ($context eq 'course') {
$uname = $sender;
my %courseinfo = &Apache::lonnet::coursedescription($cid);
$udom = $courseinfo{'num'};
}
my %sentmessage;
my $stamp = time;
my $msgcount = &Apache::lonmsg::get_uniq();
my $sender_lh = &Apache::loncommon::user_lang($uname,$udom,$cid);
$subject = &Apache::lonlocal::mt_user($sender_lh,$rawsubj);
$message = '';
foreach my $item (@rawmsg) {
if (ref($item) eq 'HASH') {
$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);
my ($recipid,$recipstatus) = &Apache::lonmsg::store_recipients($subject,$uname,$udom,\%reciphash);
my $status;
foreach my $recip (sort(keys(%{$msgcc}))) {
my ($ccname,$ccdom) = split(/:/,$recip);
my $recip_lh = &Apache::loncommon::user_lang($ccname,$ccdom,$cid);
my $subject = &Apache::lonlocal::mt_user($sender_lh,$rawsubj);
my $message = '';
foreach my $item (@rawmsg) {
if (ref($item) eq 'HASH') {
$message .= &Apache::lonlocal::mt_user($sender_lh,$item->{mt},
@{$item->{args}})."\n";
}
}
if ($context eq 'coursemanagers') {
if ($approvedlist) {
$message .= "\n\n".&Apache::lonlocal::mt_user($sender_lh,'Approved enrollments:')."\n".$approvedlist;
}
if ($rejectedlist) {
$message .= "\n\n".&Apache::lonlocal::mt_user($sender_lh,'Rejected enrollments:')."\n".$rejectedlist;
}
} elsif ($context eq 'domainmanagers') {
if ($approvedlist) {
$message .= "\n\n".&Apache::lonlocal::mt_user($sender_lh,'Approved course requests:')."\n".$approvedlist;
}
if ($rejectedlist) {
$message .= "\n\n".&Apache::lonlocal::mt_user($sender_lh,'Rejected course requests:')."\n".$rejectedlist;
}
}
$status .= &Apache::lonmsg::user_normal_msg($ccname,$ccdom,$subject,$message,undef,undef,undef,1,\%sentmessage,undef,undef,undef,1,$recipid).',';
}
$status =~ s/,$//;
return ($recipstatus,$status);
}
sub display_queued_requests {
my ($context,$dom,$cnum) = @_;
my ($namespace,$formaction,$nextelement,%requesthash);
if ($context eq 'course') {
$formaction = '/adm/createuser';
$namespace = 'selfenrollrequests';
%requesthash = &Apache::lonnet::dump($namespace,$dom,$cnum);
$nextelement = '<input type="hidden" name="state" value="done" />';
} else {
$formaction = '/adm/createcourse';
$namespace = 'courserequestqueue';
%requesthash = &Apache::lonnet::dump_dom($namespace,$dom,'_approval');
$nextelement = '<input type="hidden" name="phase" value="requestchange" />';
}
my ($output,%queue_by_date,%crstypes);
if (keys(%requesthash) > 0) {
$output = '<form method="post" name="changequeue" action="'.$formaction.'" />'."\n".
'<input type="hidden" name="action" value="'.$env{'form.action'}.'" />'."\n".
$nextelement."\n".
&Apache::loncommon::start_data_table().
&Apache::loncommon::start_data_table_header_row().
'<th>'.&mt('Action').'</th>'.
'<th>'.&mt('Requestor').'</th>';
if ($context eq 'course') {
$output .= '<th>'.&mt('Section').'</th>'.
'<th>'.&mt('Date requested').'</th>';
} else {
%crstypes = &Apache::lonlocal::texthash (
official => 'Official course',
unofficial => 'Unofficial course',
community => 'Community',
);
$output .= '<th>'.&mt('Type').'</th>'.
'<th>'.&mt('Date requested').'</th>'.
'<th>'.&mt('Details').'</th>';
}
$output .= &Apache::loncommon::end_data_table_header_row();
foreach my $item (keys(%requesthash)) {
my ($timestamp,$entry);
if ($context eq 'course') {
($timestamp, my $usec) = split(/:/,$requesthash{$item});
$entry = $item.':'.$usec;
} else {
$timestamp = $requesthash{$item}{'timestamp'};
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'};
}
}
if ($entry ne '') {
if (exists($queue_by_date{$timestamp})) {
if (ref($queue_by_date{$timestamp}) eq 'ARRAY') {
push(@{$queue_by_date{$timestamp}},$entry);
}
} else {
@{$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);
} else {
my ($cnum,$ownername,$ownerdom,$type,$cdesc)=split(/:/,$request,5);
$detailslink='<a href="javascript:opencoursereqdisplay('.
"'$dom','$cnum'".');">'.$cdesc.'</a>';
$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);
}
$row = '<td><span class="LC_nobreak"><label>'.
'<input type="checkbox" value="'.$approve.'" name="approvereq" />'.&mt('Approve').'</label></span><br />'.
'<span class="LC_nobreak"><label>'.
'<input type="checkbox" value="'.$reject.'" name="rejectreq" />'.&mt('Reject').'</label></span><br /></td>'.
'<td>'.$namelink.'</td>'."\n";
if ($context eq 'course') {
$row .= '<td>'.$showsec.'</td>'."\n".
'<td>'.$showtime.'</td>'."\n";
} else {
$row .= '<td>'.$crstype.'</td>'."\n".
'<td>'.$showtime.'</td>'."\n".
'<td>'.$detailslink.'</td>'."\n";
}
$output .= &Apache::loncommon::start_data_table_row()."\n".
$row.
&Apache::loncommon::end_data_table_row()."\n";
$count ++;
}
}
}
$output .= &Apache::loncommon::end_data_table().
'<input type="submit" name="processqueue" value="'.&mt('Save').
'" /></form>';
} 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.');
}
}
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,
@existing,@missingreq,@invalidusers,@limitexceeded,@completed,
@processing_errors,@warn_approves,@warn_rejects,@approvals,@warn_dels,
@rejections,@rejectionerrors,@nopermissions,%courseroles,
%communityroles,%domdefs,%approvalmsg,%rejectionmsg,$crstype);
@approvals = &Apache::loncommon::get_env_multiple('form.approvereq');
@rejections = &Apache::loncommon::get_env_multiple('form.rejectreq');
$now = time;
$sender = $env{'user.name'}.':'.$env{'user.domain'};
if ($context eq 'course') {
$namespace = 'selfenrollrequests';
$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');
%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'};
$limit = $env{'course.'.$cid.'.internal.selfenroll_limit'};
$cap = $env{'course.'.$cid.'.internal.selfenroll_cap'};
$notifylist = $env{'course.'.$cid.'.internal.selfenroll_notifylist'};
($stucounts,$idx,$classlist) = &get_student_counts($cdom,$cnum);
$approvedmsg = [{
mt => 'Your request for enrollment has been approved.',
},
{
mt => 'Visit [_1], to log-in and access the course',
args => [$protocol.'://'.$hostname],
}];
$rejectedmsg = [{
mt => 'Your request for enrollment has not been approved.',
}];
} else {
$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');
my %domconfig = &Apache::lonnet::get_dom('configuration',['requestcourses'],$cdom);
if (ref($domconfig{'requestcourses'}) eq 'HASH') {
if (ref($domconfig{'requestcourses'}{'notify'}) eq 'HASH') {
$notifylist = $domconfig{'requestcourses'}{'notify'}{'approval'};
}
}
$approvalmsg{'course'} =
[{
mt => 'Your course request has been approved.',
},
{
mt => 'Visit [_1], to log-in and access the course',
args => [$protocol.'://'.$hostname],
}];
$rejectionmsg{'course'} =
[{
mt => 'Your course request has not been approved.',
}];
$approvalmsg{'community'} =
[{
mt => 'Your community request has been approved.',
},
{
mt => 'Visit [_1], to log-in and access the community',
args => [$protocol.'://'.$hostname],
}];
$rejectionmsg{'community'} =
[{
mt => 'Your community request has not been approved.',
}];
%domdefs = &Apache::lonnet::get_domain_defaults($cdom);
my @roles = &Apache::lonuserutils::roles_by_context('course');
foreach my $role (@roles) {
$courseroles{$role}=&Apache::lonnet::plaintext($role,'Course');
}
foreach my $role (@roles) {
$communityroles{$role}=&Apache::lonnet::plaintext($role,'Community');
}
}
foreach my $item (sort {$a <=> $b} @approvals) {
if ($context eq 'course') {
my ($num,$uname,$udom,$usec) = split(/:/,$item);
my $uhome = &Apache::lonnet::homeserver($uname,$udom);
if ($uhome ne 'no_host') {
if (exists($requesthash{$uname.':'.$udom})) {
if (exists($classlist->{$uname.':'.$udom})) {
if (ref($classlist->{$uname.':'.$udom}) eq 'ARRAY') {
if (($classlist->{$uname.':'.$udom}->[$idx->{'status'}] eq 'Active') ||
($classlist->{$uname.':'.$udom}->[$idx->{'status'}] eq 'Future')) {
push(@existing,$uname.':'.$udom);
next;
}
}
}
} else {
push(@missingreq,$uname.':'.$udom);
next;
}
if (!grep(/^\Q$item\E$/,@rejections)) {
if ($limit eq 'allstudents') {
if ($stucounts->{$limit} >= $cap) {
push(@limitexceeded,$uname.':'.$udom);
last;
}
} elsif ($limit eq 'selfenrolled') {
if ($stucounts->{$limit} >= $cap) {
push(@limitexceeded,$uname.':'.$udom);
last;
}
}
my $result =
&Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$usec,$access_end,$access_start,'selfenroll',undef,$cdom.'_'.$cnum,1);
if ($result eq 'ok') {
push(@completed,$uname.':'.$udom);
$stucounts->{'allstudents'} ++;
$stucounts->{'selfenrolled'} ++;
&send_selfserve_notification($uname.':'.$udom,$approvedmsg,
$cid,$coursedesc,$now,$beneficiary,$sender,undef,undef,$crstype);
my %userrequest = (
$cdom.'_'.$cnum => {
timestamp => $now,
section => $usec,
adjudicator => $env{'user.name'}.':'.$env{'user.domain'},
status => 'approved',
}
);
my $userresult =
&Apache::lonnet::put($namespace,\%userrequest,$udom,$uname);
if ($userresult ne 'ok') {
push(@warn_approves,$uname.':'.$udom);
}
} else {
push(@processing_errors,$uname.':'.$udom);
}
}
} else {
push(@invalidusers,$uname.':'.$udom);
}
} else {
my ($num,$cnum) = split(':',$item);
if (ref($requesthash{$cnum.'_approval'}) 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 $longroles = \%courseroles;
if ($crstype eq 'community') {
$longroles = \%communityroles;
}
my $cancreate;
if ($cdom eq $ownerdom) {
if (&Apache::lonnet::usertools_access($ownername,$ownerdom,$crstype,
undef,'requestcourses')) {
$cancreate = 1;
}
} else {
my %userenv = &Apache::lonnet::userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.$crstype);
if ($userenv{'reqcrsotherdom.'.$crstype}) {
my @doms = split(',',$userenv{'reqcrsotherdom.'.$crstype});
if (grep(/^\Q$cdom\E:/,@doms)) {
$cancreate = 1;
}
}
}
if ($cancreate) {
my $requestkey = $cdom.'_'.$cnum;
my %history =
&Apache::lonnet::restore($requestkey,'courserequests',
$ownerdom,$ownername);
if ((ref($history{'details'}) eq 'HASH') &&
($history{'disposition'} eq 'approval')) {
my ($logmsg,$newusermsg,$addresult,$enrollcount,$response,$keysmsg);
my $result = &course_creation($cdom,$cnum,$context,$history{'details'},\$logmsg,
\$newusermsg,\$addresult,\$enrollcount,
\$response,\$keysmsg,\%domdefs,$longroles);
if ($result eq 'created') {
if ($crstype eq 'community') {
$approvedmsg = $approvalmsg{'community'};
} else {
$approvedmsg = $approvalmsg{'course'};
}
push(@completed,$cnum);
unless (&Apache::lonnet::del_dom($namespace,[$cnum.'_approval'],$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'},
details => $history{'details'},
disposition => $history{'disposition'},
status => 'created',
adjudicator => $env{'user.name'}.':'.
$env{'user.domain'},
);
my $userresult =
&Apache::lonnet::store_userdata(\%reqhash,$requestkey,
'courserequests',$ownerdom,$ownername);
if ($userresult eq 'ok') {
my %status = (
'status:'.$cdom.':'.$cnum => 'created'
);
my $statusresult =
&Apache::lonnet::put('courserequests',\%status,
$ownerdom,$ownername);
if ($statusresult ne 'ok') {
push(@warn_approves,$cnum);
}
}
if ($userresult ne 'ok') {
push(@warn_approves,$cnum);
}
} else {
push(@processing_errors,$cnum);
}
} else {
push(@processing_errors,$cnum);
}
} else {
push(@nopermissions,$cnum);
}
} else {
push(@existing,$cnum);
}
} else {
push(@missingreq,$cnum);
}
}
}
my @changes = (@completed,@rejections);
if ($context eq 'domain') {
@changes = map {$_.'_approval'} (@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);
my ($uname,$udom) = split(/:/,$user);
my %userrequest = (
$cdom.'_'.$cnum => {
timestamp => $now,
adjudicator => $env{'user.name'}.':'.$env{'user.domain'},
status => 'rejected',
}
);
my $userresult =
&Apache::lonnet::put($namespace,\%userrequest,$udom,$uname);
if ($userresult ne 'ok') {
push(@warn_rejects,$user);
}
} else {
my $cnum = $item;
if (ref($requesthash{$cnum.'_approval'}) 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'};
if ($crstype eq 'community') {
$rejectedmsg = $rejectionmsg{'community'};
} else {
$rejectedmsg = $rejectionmsg{'course'};
}
&send_selfserve_notification($ownername.':'.$ownerdom,$rejectedmsg,
$cid,$coursedesc,$now,$beneficiary,
$sender,undef,undef,$crstype);
my %history =
&Apache::lonnet::restore($requestkey,'courserequests',
$ownerdom,$ownername);
if ((ref($history{'details'}) eq 'HASH') &&
($history{'disposition'} eq 'approval')) {
my %reqhash = (
reqtime => $history{'reqtime'},
crstype => $history{'crstype'},
details => $history{'details'},
disposition => $history{'disposition'},
status => 'rejected',
adjudicator => $env{'user.name'}.':'.$env{'user.domain'},
);
my $userresult =
&Apache::lonnet::store_userdata(\%reqhash,$requestkey,
'courserequests',$ownerdom,$ownername);
if ($userresult eq 'ok') {
my %status = (
'status:'.$cdom.':'.$cnum => 'rejected'
);
my $statusresult =
&Apache::lonnet::put('courserequests',\%status,
$ownerdom,$ownername);
if ($statusresult ne 'ok') {
push(@warn_rejects,$cnum);
}
} else {
push(@warn_rejects,$cnum);
}
unless (&Apache::lonnet::del_dom($namespace,[$cnum.'_approval'],$cdom) eq 'ok') {
push(@warn_dels,$cnum);
}
} else {
push(@warn_rejects,$cnum);
}
} else {
push(@existing,$cnum);
}
} else {
push(@rejectionerrors,$cnum);
}
}
}
}
if (@changes) {
my $delresult;
if ($context eq 'course') {
$delresult = &Apache::lonnet::del($namespace,\@changes,$cdom,$cnum);
} else {
$delresult = &Apache::lonnet::del_dom($namespace,\@changes,$cdom);
}
if ($delresult eq 'ok') {
my $namelink =
&Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'}).' ('.$env{'user.name'}.':'.$env{'user.domain'}.')';
my ($chgmsg,$approvedlist,$rejectedlist);
if ($context eq 'course') {
$chgmsg = "'Action was taken on the following enrollment requests by [_1].',$namelink";
if (@completed) {
$approvedlist = join("\n",@completed);
if ($crstype eq 'community') {
$output .= '<p>'.&mt('The following were enrolled in the community:').'<ul>';
} else {
$output .= '<p>'.&mt('The following were enrolled in the course:').'<ul>';
}
foreach my $user (@completed) {
my ($uname,$udom) = split(/:/,$user);
my $userlink =
&Apache::loncommon::aboutmewrapper(&Apache::loncommon::plainname($uname,$udom),$uname,$udom);
$output .= '<li>'.$userlink.'</li>';
}
$output .= '</ul></p>';
}
if (@rejections) {
$rejectedlist = join("\n",@rejections);
$output .= '<p>'.&mt('The following enrollment requests were rejected:').'<ul>';
foreach my $user (@rejections) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
}
if ($notifylist ne '') {
&send_selfserve_notification($notifylist,$chgmsg,$cid,$coursedesc,
$now,'coursemanagers',$sender,
$approvedlist,$rejectedlist,$crstype);
}
} else {
$chgmsg = "'Action was taken on the following course and community requests by [_1].',$namelink";
if (@completed) {
$approvedlist = join("\n",@completed);
$output .= '<p>'.&mt('The following courses/communities were created:').'<ul>';
foreach my $cnum (@completed) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
my $syllabuslink =
&Apache::loncommon::syllabuswrapper($showcourse,$cnum,$cdom);
$output .= '<li>'.$syllabuslink.'</li>';
}
$output .= '</ul></p>';
}
if (@rejections) {
$rejectedlist = join("\n",@rejections);
$output .= '<p>'.&mt('The following requests were rejected:').'<ul>';
foreach my $cnum (@rejections) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
if ($notifylist ne '') {
&send_selfserve_notification($notifylist,$chgmsg,$cid,$domdesc,
$now,'domainmanagers',$sender,
$approvedlist,$rejectedlist,$crstype);
}
}
}
}
if (@existing) {
if ($context eq 'course') {
$output .= '<p>'.&mt('The following enrollment requests were deleted because the user is already enrolled in the course:').'<ul>';
foreach my $user (@existing) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
} else {
$output .= '<p>'.&mt('The following course/community creation requests were deleted because the course or community has already been created:').'<ul>';
foreach my $cnum (@existing) {
my $showcourse;
my %coursehash = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
if ($coursehash{'description'} ne '') {
$showcourse = $coursehash{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
}
if (@missingreq) {
if ($context eq 'course') {
$output .= '<p>'.&mt('The following enrollment requests were ignored because the request is no longer in the enrollment queue:').'<ul>';
foreach my $user (@missingreq) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
} else {
$output .= '<p>'.&mt('The following course/community creation requests were ignored because the request is no longer in the queue:').'<ul>';
foreach my $cnum (@missingreq) {
$output .= '<li>'.$cnum.'</li>';
}
$output .= '</ul></p>';
}
}
if (@invalidusers) {
if ($context eq 'course') {
$output .= '<p>'.&mt('The following enrollment requests were deleted because the requestor does not have a LON-CAPA account:').'<ul>';
foreach my $user (@invalidusers) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
}
}
if (@limitexceeded) {
if ($context eq 'course') {
$output .= '<p>'.&mt('The following enrollment requests were skipped because the enrollment limit has been reached for the course:').'<ul>';
foreach my $user (@limitexceeded) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
}
}
if (@nopermissions) {
$output .= '<p>'.&mt('The following course/community creation requests could not be processed because the owner does not have rights to create this type of course:').'<ul>';
foreach my $cnum (@nopermissions) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
if (@processing_errors) {
if ($context eq 'course') {
$output .= '<p>'.&mt('The following enrollment requests could not be processed because an error occurred:').'<ul>';
foreach my $user (@processing_errors) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
} else {
$output .= '<p>'.&mt('The following course/community creation requests could not be processed because an error occurred:').'<ul>';
foreach my $cnum (@processing_errors) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
}
if (@rejectionerrors) {
$output .= '<p>'.&mt('The following course/community creation request rejections could not be fully processed because an error occurred:').'<ul>';
foreach my $cnum (@rejectionerrors) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
if (@warn_approves || @warn_rejects) {
if ($context eq 'course') {
$output .= '<p>'.&mt("For the following users, an error occurred when updating the user's own self-enroll requests record:").'<ul>';
foreach my $user (@warn_approves) {
$output .= '<li>'.$user.'</li>';
}
$output .= '</ul></p>';
} else {
$output .= '<p>'.&mt("For the following course/community requests an error occurred when updating the requestor's own requests record:").'<ul>';
foreach my $cnum (@warn_approves,@warn_rejects) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
}
if (@warn_dels) {
$output .= '<p>'.&mt("For the following course/community requests an error occurred when removing requests for the following from the pending queue:").'<ul>';
foreach my $cnum (@warn_dels) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
$showcourse = $requesthash{$cnum.'_approval'}{'description'};
} else {
$showcourse = $cnum;
}
$output .= '<li>'.$showcourse.'</li>';
}
$output .= '</ul></p>';
}
return $output;
}
sub get_student_counts {
my ($cdom,$cnum) = @_;
my (%idx,%stucounts);
my $classlist = &Apache::loncoursedata::get_classlist($cdom,$cnum);
$idx{'type'} = &Apache::loncoursedata::CL_TYPE();
$idx{'status'} = &Apache::loncoursedata::CL_STATUS();
while (my ($student,$data) = each(%$classlist)) {
if (($data->[$idx{'status'}] eq 'Active') ||
($data->[$idx{'status'}] eq 'Future')) {
if ($data->[$idx{'type'}] eq 'selfenroll') {
$stucounts{'selfenroll'} ++;
}
$stucounts{'allstudents'} ++;
}
}
return (\%stucounts,\%idx,$classlist);
}
sub course_creation {
my ($dom,$cnum,$context,$details,$logmsg,$newusermsg,$addresult,$enrollcount,$output,
$keysmsg,$domdefs,$longroles) = @_;
unless ((ref($details) eq 'HASH') && (ref($domdefs) eq 'HASH') &&
(ref($longroles) eq 'HASH')) {
return 'error: Invalid request';
}
my ($result,$ownername,$ownerdom);
my $crstype = $details->{'crstype'};
if ($context eq 'domain') {
$ownername = $details->{'owner'};
$ownerdom = $details->{'domain'};
} else {
$ownername = $env{'user.name'};
$ownerdom = $env{'user.domain'};
}
my $owneremail;
my %emails = &Apache::loncommon::getemails($ownername,$ownerdom);
foreach my $email ('permanentemail','critnotification','notification') {
$owneremail = $emails{$email};
last if ($owneremail ne '');
}
my %reqdetails = &build_batchcreatehash($dom,$context,$details,$owneremail,$domdefs);
my $cid = &LONCAPA::batchcreatecourse::build_course($dom,$cnum,'requestcourses',
\%reqdetails,$longroles,\$logmsg,\$newusermsg,\$addresult,
\$enrollcount,\$output,\$keysmsg,$ownerdom,$ownername,$cnum,$crstype);
if ($cid eq "/$dom/$cnum") {
$result = 'created';
} else {
$result = 'error: '.$cid;
}
return $result;
}
sub build_batchcreatehash {
my ($dom,$context,$details,$owneremail,$domdefs) = @_;
my %batchhash;
my @items = qw{owner domain coursehome clonecrs clonedom datemode dateshift enrollstart enrollend accessstart accessend sections crosslists users};
if ((ref($details) eq 'HASH') && (ref($domdefs) eq 'HASH')) {
my $emailenc = &escape($owneremail);
my $owner = $details->{'owner'}.':'.$details->{'domain'};
foreach my $item (@items) {
$batchhash{$item} = $details->{$item};
}
$batchhash{'title'} = $details->{'cdescr'};
$batchhash{'coursecode'} = $details->{'instcode'};
$batchhash{'emailenc'} = $emailenc;
$batchhash{'adds'} = $details->{'autoadds'};
$batchhash{'drops'} = $details->{'autodrops'};
$batchhash{'authtype'} = $domdefs->{'auth_def'};
$batchhash{'authparam'} = $domdefs->{'auth_arg_def'};
if ($details->{'crstype'} eq 'community') {
$batchhash{'crstype'} = 'Community';
} else {
$batchhash{'crstype'} = 'Course';
}
my ($owner_firstname,$owner_lastname);
if ($context eq 'domain') {
my %userenv = &Apache::lonnet::userenvironment($details->{'domain'},
$details->{'owner'},
'firstname','lastname');
$owner_firstname = $userenv{'firstname'};
$owner_lastname = $userenv{'lastname'};
} else {
$owner_firstname = $env{'environment.firstname'};
$owner_lastname = $env{'environment.lastname'};
}
if (ref($details->{'personnel'}) eq 'HASH') {
%{$batchhash{'users'}} = %{$details->{'personnel'}};
if (ref($batchhash{'users'}) eq 'HASH') {
foreach my $userkey (keys(%{$batchhash{'users'}})) {
if (ref($batchhash{'users'}{$userkey}) eq 'HASH') {
if (ref($batchhash{'users'}{$userkey}{'roles'}) eq 'ARRAY') {
foreach my $role (@{$batchhash{'users'}{$userkey}{'roles'}}) {
my $start = '';
my $end = '';
if ($role eq 'st') {
$start = $details->{'accessstart'};
$end = $details->{'accessend'};
}
$batchhash{'users'}{$userkey}{$role}{'start'} = $start;
$batchhash{'users'}{$userkey}{$role}{'end'} = $end;
}
}
}
}
}
}
$batchhash{'users'}{$owner}{firstname} = $owner_firstname;
$batchhash{'users'}{$owner}{lastname} = $owner_lastname;
$batchhash{'users'}{$owner}{emailenc} = $emailenc;
$batchhash{'users'}{$owner}{owneremail} = $owneremail;
}
return %batchhash;
}
sub can_clone_course {
my ($uname,$udom,$clonecrs,$clonedom,$crstype) = @_;
my $canclone;
my $ccrole = 'cc';
if ($crstype eq 'community') {
$ccrole = 'co';
}
my %roleshash = &Apache::lonnet::get_my_roles($uname,$udom,'userroles',['active'],
[$ccrole],[$clonedom]);
if (exists($roleshash{$clonecrs.':'.$clonedom.':'.$ccrole})) {
$canclone = 1;
} else {
my %courseenv = &Apache::lonnet::userenvironment($clonedom,$clonecrs,('cloners'));
my $cloners = $courseenv{'cloners'};
if ($cloners ne '') {
my @cloneable = split(',',$cloners);
if (grep(/^\*$/,@cloneable)) {
$canclone = 1;
}
if (grep(/^\*:\Q$udom\E$/,@cloneable)) {
$canclone = 1;
}
if (grep(/^\Q$uname\E:\Q$udom\E$/,@cloneable)) {
$canclone = 1;
}
}
unless ($canclone) {
if (&Apache::lonnet::is_course_owner($clonedom,$clonecrs,$uname,$udom)) {
$can_clone = 1;
}
}
}
return $canclone;
}
sub get_processtype {
my ($uname,$udom,$isadv,$dom,$crstype,$inststatuses,$domconfig) = @_;
return unless ((ref($inststatuses) eq 'ARRAY') && (ref($domconfig) eq 'HASH'));
if ($uname eq '' || $udom eq '') {
$uname = $env{'user.name'};
$udom = $env{'user.domain'};
$isadv = $env{'user.adv'};
}
my (%userenv,%settings,$val);
my @options = ('autolimit','validate','approval');
if ($dom eq $udom) {
%userenv =
&Apache::lonnet::userenvironment($udom,$uname,'requestcourses.'.$crstype,'inststatus');
if ($userenv{'requestcourses.'.$crstype}) {
$val = $userenv{'requestcourses.'.$crstype};
@{$inststatuses} = ('_custom_');
} else {
my ($task,%alltasks);
if (ref($domconfig->{'requestcourses'}) eq 'HASH') {
%settings = %{$domconfig->{'requestcourses'}};
if (ref($settings{$crstype}) eq 'HASH') {
if (($isadv) && ($settings{$crstype}{'_LC_adv'} ne '')) {
$val = $settings{$crstype}{'_LC_adv'};
@{$inststatuses} = ('_LC_adv_');
} else {
if ($userenv{'inststatus'} ne '') {
@{$inststatuses} = split(',',$userenv{'inststatus'});
} else {
@{$inststatuses} = ('default');
}
foreach my $status (@{$inststatuses}) {
if (exists($settings{$crstype}{$status})) {
my $value = $settings{$crstype}{$status};
next unless ($value);
unless (exists($alltasks{$value})) {
if (ref($alltasks{$value}) eq 'ARRAY') {
unless(grep(/^\Q$status\E$/,@{$alltasks{$value}})) {
push(@{$alltasks{$value}},$status);
}
} else {
@{$alltasks{$value}} = ($status);
}
}
}
}
my $maxlimit = 0;
foreach my $key (sort(keys(%alltasks))) {
if ($key =~ /^autolimit=(\d*)$/) {
if ($1 eq '') {
$val ='autolimit=';
last;
} elsif ($1 > $maxlimit) {
$maxlimit = $1;
}
}
}
if ($maxlimit) {
$val = 'autolimit='.$maxlimit;
} else {
foreach my $option (@options) {
if ($alltasks{$option}) {
$val = $option;
last;
}
}
}
}
}
}
}
} else {
%userenv = &Apache::lonnet::userenvironment($udom,$uname,'reqcrsotherdom.'.$crstype);
if ($userenv{'reqcrsotherdom.'.$crstype}) {
my @doms = split(',',$userenv{'reqcrsotherdom.'.$crstype});
my $optregex = join('|',@options);
foreach my $item (@doms) {
my ($extdom,$extopt) = split(':',$item);
if ($extdom eq $dom) {
if ($extopt =~ /^($optregex)(=?\d*)$/) {
$val = $1.$2;
}
last;
}
}
@{$inststatuses} = ('_external_');
}
}
return $val;
}
sub queued_selfenrollment {
my ($notitle) = @_;
my $output;
my %selfenrollrequests = &Apache::lonnet::dump('selfenrollrequests');
my %reqs_by_date;
foreach my $item (keys(%selfenrollrequests)) {
if (ref($selfenrollrequests{$item}) eq 'HASH') {
if ($selfenrollrequests{$item}{'status'} eq 'request') {
if ($selfenrollrequests{$item}{'timestamp'}) {
push(@{$reqs_by_date{$selfenrollrequests{$item}{'timestamp'}}},$item);
}
}
}
}
if (keys(%reqs_by_date)) {
unless ($notitle) {
$output .= '<b>'.&mt('Enrollment requests pending Course Coordinator approval').'</b><br />';
}
$output .= &Apache::loncommon::start_data_table().
&Apache::loncommon::start_data_table_header_row().
'<th>'.&mt('Date requested').'</th><th>'.&mt('Course title').'</th>'.
'<th>'.&mt('User role').'</th><th>'.&mt('Section').'</th>'.
&Apache::loncommon::end_data_table_header_row();
my @sorted = sort { $a <=> $b } (keys(%reqs_by_date));
foreach my $item (@sorted) {
if (ref($reqs_by_date{$item}) eq 'ARRAY') {
foreach my $crs (@{$reqs_by_date{$item}}) {
my %courseinfo = &Apache::lonnet::coursedescription($crs);
my $usec = $selfenrollrequests{$crs}{'section'};
my $rolename = &Apache::lonnet::plaintext('st',$courseinfo{'type'},$crs);
if ($usec eq '') {
$usec = &mt('No section');
}
$output .= &Apache::loncommon::start_data_table_row().
'<td>'.&Apache::lonlocal::locallocaltime($item).'</td>'.
'<td>'.$courseinfo{'description'}.'</td>'.
'<td>'.$rolename.'</td><td>'.$usec.'</td>'.
&Apache::loncommon::end_data_table_row();
}
}
}
$output .= &Apache::loncommon::end_data_table();
}
return $output;
}
sub update_coursereq_status {
my ($reqhash,$dom,$cnum,$reqstatus,$context) = @_;
my ($storeresult,$statusresult,$output);
my $requestkey = $dom.'_'.$cnum;
if ($requestkey =~ /^($match_domain)_($match_courseid)$/) {
$storeresult = &Apache::lonnet::store_userdata($reqhash,$requestkey,
'courserequests');
if ($storeresult eq 'ok') {
my %status = (
'status:'.$dom.':'.$cnum => $reqstatus,
);
$statusresult = &Apache::lonnet::put('courserequests',\%status);
}
} else {
$storeresult = 'error: invalid requestkey format';
}
if ($storeresult ne 'ok') {
$output = &mt('An error occurred saving a record of the details of your request: [_1].',$storeresult);
if ($context eq 'domain') {
$output .= "\n";
} else {
$output = '<span class="LC_warning">'.$output.'</span><br />';
}
&Apache::lonnet::logthis("Error saving course request - $requestkey for $env{'user.name'}:$env{'user.domain'} - $storeresult");
} elsif ($statusresult ne 'ok') {
$output = &mt('An error occurred saving a record of the status of your request: [_1].',$statusresult);
if ($context eq 'domain') {
$output .= "\n";
} else {
$output = '<span class="LC_warning">'.$output.'</span><br />';
}
&Apache::lonnet::logthis("Error saving course request status for $requestkey (for $env{'user.name'}:$env{'user.domain'}) - $statusresult");
}
return ($storeresult,$output);
}
1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncoursequeueadmin.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface