--- loncom/interface/loncoursequeueadmin.pm 2009/08/20 20:43:08 1.5
+++ loncom/interface/loncoursequeueadmin.pm 2010/01/16 16:15:08 1.15
@@ -1,7 +1,7 @@
# The LearningOnline Network
# Utilities to administer domain course requests and course self-enroll requests
#
-# $Id: loncoursequeueadmin.pm,v 1.5 2009/08/20 20:43:08 raeburn Exp $
+# $Id: loncoursequeueadmin.pm,v 1.15 2010/01/16 16:15:08 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -33,7 +33,9 @@ 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.
@@ -50,6 +52,16 @@ described at http://www.lon-capa.org.
=item get_student_counts()
+=item course_creation()
+
+=item build_batchcreatehash()
+
+=item can_clone_course()
+
+=item get_processtype()
+
+=item queued_selfenrollment()
+
=back
=cut
@@ -57,7 +69,6 @@ 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;
@@ -67,22 +78,22 @@ use LONCAPA;
sub send_selfserve_notification {
my ($notifylist,$textstr,$cid,$contextdesc,$timestamp,$context,$sender,
- $approvedlist,$rejectedlist) = @_;
+ $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);
+ 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.',
+ mt => 'Enrollment requests in the following course: [_1] have been processed.',
args => ["\n $contextdesc"],
});
} elsif ($context eq 'domainmanagers') {
- $rawsubj = 'Course requests reviewed';
+ $rawsubj = 'Course/Community requests reviewed';
push(@rawmsg,{
- mt => 'Course creation requests in the following domain: [_1]have been reviewed.',
+ mt => 'Course/Community creation requests in the following domain: [_1] have been reviewed.',
args => ["\n $contextdesc"],
});
if (ref($textstr) eq 'ARRAY') {
@@ -90,8 +101,13 @@ sub send_selfserve_notification {
}
} 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 => 'Your request for enrollment in the following course: [_1]requested on [_2]has been reviewed by a Course Coordinator.',
+ mt => $msgtxt,
args => ["\n ".$contextdesc.",\n",$timestamp.",\n"],
});
@@ -99,9 +115,15 @@ sub send_selfserve_notification {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'courserequestor') {
- $rawsubj = 'Course request';
+ 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 => 'Your request for creation of the following course: [_1]requested on [_2]has been reviewed by a Domain Coordinator.',
+ mt => $msgtxt,
args => ["\n".$contextdesc.",\n",$timestamp.",\n"],
});
@@ -109,35 +131,44 @@ sub send_selfserve_notification {
push(@rawmsg,@{$textstr});
}
} elsif ($context eq 'coursereq') {
- $rawsubj = 'Course request to review',
+ 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 => 'Creation of the following course: [_1]was requested by [_2] on [_3].',
+ mt => $msgtxt,
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.',
+ 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 => 'Enrollment in the following course: [_1] was requested by [_2] on [_3].',
+ mt => $msgtxt,
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"],
- });
+ 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 {
- push(@rawmsg,
+ $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 =>'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.',
+ mt => $directions,
args => [" \n\n","\n"],
});
- }
}
my @to_notify = split(/,/,$notifylist);
my $numsent = 0;
@@ -188,7 +219,7 @@ sub send_selfserve_notification {
@{$item->{args}})."\n";
}
}
- if ($context eq 'managers') {
+ if ($context eq 'coursemanagers') {
if ($approvedlist) {
$message .= "\n\n".&Apache::lonlocal::mt_user($sender_lh,'Approved enrollments:')."\n".$approvedlist;
}
@@ -220,7 +251,7 @@ sub display_queued_requests {
} else {
$formaction = '/adm/createcourse';
$namespace = 'courserequestqueue';
- %requesthash = &Apache::lonnet::dump_dom($namespace,$dom,undef,'_approval');
+ %requesthash = &Apache::lonnet::dump_dom($namespace,$dom,'_approval');
$nextelement = '';
}
my ($output,%queue_by_date,%crstypes);
@@ -235,12 +266,12 @@ sub display_queued_requests {
if ($context eq 'course') {
$output .= '
'.&mt('The following were enrolled in the community:').'
';
+ } else {
+ $output .= '
'.&mt('The following were enrolled in the course:').'
';
+ }
foreach my $user (@completed) {
my ($uname,$udom) = split(/:/,$user);
my $userlink =
@@ -666,13 +730,13 @@ sub update_request_queue {
if ($notifylist ne '') {
&send_selfserve_notification($notifylist,$chgmsg,$cid,$coursedesc,
$now,'coursemanagers',$sender,
- $approvedlist,$rejectedlist);
+ $approvedlist,$rejectedlist,$crstype);
}
} else {
- $chgmsg = "'Action was taken on the following course requests by [_1].',$namelink";
+ $chgmsg = "'Action was taken on the following course and community requests by [_1].',$namelink";
if (@completed) {
$approvedlist = join("\n",@completed);
- $output .= '
'.&mt('The following courses were created:').'
';
+ $output .= '
'.&mt('The following courses/communities were created:').'
';
foreach my $cnum (@completed) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
@@ -703,7 +767,7 @@ sub update_request_queue {
if ($notifylist ne '') {
&send_selfserve_notification($notifylist,$chgmsg,$cid,$domdesc,
$now,'domainmanagers',$sender,
- $approvedlist,$rejectedlist);
+ $approvedlist,$rejectedlist,$crstype);
}
}
}
@@ -716,7 +780,7 @@ sub update_request_queue {
}
$output .= '
';
} else {
- $output .= '
'.&mt('The following course creation requests were deleted because the course has already been created:').'
';
+ $output .= '
'.&mt('The following course/community creation requests were deleted because the course or community has already been created:').'
';
foreach my $cnum (@existing) {
my $showcourse;
my %coursehash = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
@@ -738,7 +802,7 @@ sub update_request_queue {
}
$output .= '
';
} else {
- $output .= '
'.&mt('The following course creation requests were ignored because the request is no longer in the course request queue:').'
';
+ $output .= '
'.&mt('The following course/community creation requests were ignored because the request is no longer in the queue:').'
';
foreach my $cnum (@missingreq) {
$output .= '
'.$cnum.'
';
}
@@ -765,7 +829,7 @@ sub update_request_queue {
}
}
if (@nopermissions) {
- $output .= '
'.&mt('The following course creation requests could not be processed because the course owner does hot have rights to create this type of course:').'
';
+ $output .= '
'.&mt('The following course/community creation requests could not be processed because the owner does not have rights to create this type of course:').'
';
foreach my $cnum (@nopermissions) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
@@ -785,7 +849,7 @@ sub update_request_queue {
}
$output .= '
';
} else {
- $output .= '
'.&mt('The following course creation requests could not be processed because an error occurred:').'
';
+ $output .= '
'.&mt('The following course/community creation requests could not be processed because an error occurred:').'
';
foreach my $cnum (@processing_errors) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
@@ -799,7 +863,7 @@ sub update_request_queue {
}
}
if (@rejectionerrors) {
- $output .= '
'.&mt('The following course creation request rejections could not be fully processed because an error occurred:').'
';
+ $output .= '
'.&mt('The following course/community creation request rejections could not be fully processed because an error occurred:').'
';
foreach my $cnum (@rejectionerrors) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
@@ -819,7 +883,7 @@ sub update_request_queue {
}
$output .= '
';
} else {
- $output .= '
'.&mt("For the following course requests an error occurred when updating the requestor's own course requests record:").'
';
+ $output .= '
'.&mt("For the following course/community requests an error occurred when updating the requestor's own requests record:").'
';
foreach my $cnum (@warn_approves,@warn_rejects) {
my $showcourse;
if (ref($requesthash{$cnum.'_approval'})) {
@@ -869,17 +933,13 @@ sub course_creation {
$ownername = $env{'user.name'};
$ownerdom = $env{'user.domain'};
}
- my $type = 'Course';
- if ($crstype eq 'community') {
- $type = 'Community';
- }
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,$details,$owneremail,$domdefs);
+ 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);
@@ -892,7 +952,7 @@ sub course_creation {
}
sub build_batchcreatehash {
- my ($dom,$details,$owneremail,$domdefs) = @_;
+ 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')) {
@@ -913,22 +973,56 @@ sub build_batchcreatehash {
} else {
$batchhash{'crstype'} = 'Course';
}
- $batchhash{'users'}{$details->{$owner}} = {
- firstname => $env{'environment.first'},
- lastname => $env{'environment.last'},
- emailenc => $emailenc,
- email => $owneremail,
- };
+ 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) = @_;
+ 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'],
- ['cc'],[$clonedom]);
- if (exists($roleshash{$clonedom.':'.$clonecrs.':cc'})) {
+ [$ccrole],[$clonedom]);
+ if (exists($roleshash{$clonecrs.':'.$clonedom.':'.$ccrole})) {
$canclone = 1;
} else {
my %courseenv = &Apache::lonnet::userenvironment($clonedom,$clonecrs,('cloners'));
@@ -949,4 +1043,141 @@ sub can_clone_course {
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)) {
+ my $rolename = &Apache::lonnet::plaintext('st');
+ unless ($notitle) {
+ $output .= ''.&mt('Enrollment requests pending Course Coordinator approval').' ';
+ }
+ $output .= &Apache::loncommon::start_data_table().
+ &Apache::loncommon::start_data_table_header_row().
+ '
'.&mt('Date requested').'
'.&mt('Course title').'
'.
+ '
'.&mt('User role').'
'.&mt('Section').'
'.
+ &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'};
+ if ($usec eq '') {
+ $usec = &mt('No section');
+ }
+ $output .= &Apache::loncommon::start_data_table_row().
+ '