# The LearningOnline Network
# Utilities to administer domain course requests and course self-enroll requests
#
# $Id: loncoursequeueadmin.pm,v 1.2 2009/08/16 19:16:16 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
Adminitsration utilities used by domain coordinators for queued course creation requests, and by course coordinators for 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()
=back
=cut
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;
sub send_selfserve_notification {
my ($notifylist,$textstr,$cid,$contextdesc,$timestamp,$context,$sender,
$approvedlist,$rejectedlist) = @_;
# 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);
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\n"],
});
} elsif ($context eq 'domainmanagers') {
$rawsubj = 'Course requests reviewed';
push(@rawmsg,{
mt => 'Course creation requests in the following domain: [_1]have been reviewed.',
args => ["\n $contextdesc\n"],
});
if (ref($textstr) eq 'ARRAY') {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'enroller') {
$rawsubj = 'Enrollment request';
push(@rawmsg,{
mt => 'Your request for enrollment in the following course: [_1]requested on [_2]has been reviewed by a Course Coordinator.',
args => ["\n ".$contextdesc.",\n",$timestamp.",\n"],
});
if (ref($textstr) eq 'ARRAY') {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'courserequestor') {
$rawsubj = 'Course request';
push(@rawmsg,{
mt => 'Your request for creation of the following course: [_1]requested on [_2]has been reviewed by a Domain Coordinator.',
args => ["\n".$contextdesc.",\n",$timestamp.",\n"],
});
if (ref($textstr) eq 'ARRAY') {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'coursereq') {
$rawsubj = 'Course request to review',
push(@rawmsg,{
mt => 'Creation of the following course: [_1]was requested by [_2] on [_3].',
args => ["\n $contextdesc\n",$textstr,$timestamp],
},
{
mt =>'[_1]As Domain Coordinator, use: [_2]Main Menu -> Create a new course -> Approve or reject course 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';
push(@rawmsg,{
mt => 'Enrollment in the following course: [_1] was requested by [_2] on [_3].',
args => ["\n $contextdesc\n",$textstr,$timestamp."\n"],
});
if ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Community') {
push(@rawmsg,
{
mt =>'As 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.',
args => [" \n\n","\n"],
});
} else {
push(@rawmsg,
{
mt =>'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.',
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 'managers') {
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 = '';
} else {
$formaction = '/adm/createcourse';
$namespace = 'courserequestqueue';
%requesthash = &Apache::lonnet::dump_dom($namespace,$dom,undef,'_approval');
$nextelement = '';
}
my ($output,%queue_by_date,%crstypes);
if (keys(%requesthash) > 0) {
$output = '
'.&mt('The following enrollment requests were rejected:').'
';
foreach my $user (@rejections) {
$output .= '
'.$user.'
';
}
$output .= '
';
}
if ($notifylist ne '') {
&send_selfserve_notification($notifylist,$chgmsg,$cid,$coursedesc,
$now,'coursemanagers',$sender,
$approvedlist,$rejectedlist);
}
} else {
$chgmsg = "'Action was taken on the following course requests by [_1].',$namelink";
if (@completed) {
$approvedlist = join("\n",@completed);
$output .= '
'.&mt('The following courses were created:').'
';
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 .= '