--- loncom/interface/loncoursequeueadmin.pm 2009/08/11 00:39:45 1.1 +++ loncom/interface/loncoursequeueadmin.pm 2009/08/17 04:39:15 1.4 @@ -1,7 +1,7 @@ # The LearningOnline Network # Utilities to administer domain course requests and course self-enroll requests # -# $Id: loncoursequeueadmin.pm,v 1.1 2009/08/11 00:39:45 raeburn Exp $ +# $Id: loncoursequeueadmin.pm,v 1.4 2009/08/17 04:39:15 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -62,30 +62,28 @@ 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,$coursedesc,$timestamp,$context,$sender, + 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,$namelink); - $namelink = &Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'})); + 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$coursedesc\n"], + mt => 'Enrollment requests in the following course: [_1]have been processed.', + args => ["\n $contextdesc"], }); } elsif ($context eq 'domainmanagers') { - $rawsubj = 'Course request'; + $rawsubj = 'Course requests reviewed'; push(@rawmsg,{ - mt => 'Your request for creation of the following course: [_1], requested on [_2], has been reviewed by a Domain Coordinator.', - args => ["\n$coursedesc\n","$timestamp\n"], - + mt => 'Course creation requests in the following domain: [_1]have been reviewed.', + args => ["\n $contextdesc"], }); if (ref($textstr) eq 'ARRAY') { push(@rawmsg,@{$textstr}); @@ -93,8 +91,8 @@ sub send_selfserve_notification { } 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$coursedesc\n","$timestamp\n"], + 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') { @@ -103,32 +101,43 @@ sub send_selfserve_notification { } 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$coursedesc\n","$timestamp\n"], + 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$coursedesc\n",$textstr,$timestamp], + mt => 'Creation of the following course: [_1]was requested by [_2] on [_3].', + args => ["\n $contextdesc\n",$textstr,$timestamp], }, { - mt =>'As Domain Coordinator, use: [_1]Main Menu -> Create a new course -> Manage Course Requests[_1] to display a list of pending course requests,[_1] which you can either approve or reject.', - args => ["\n"], + 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$coursedesc\n",$textstr,$timestamp], - }, + args => ["\n $contextdesc\n",$textstr,$timestamp."\n"], + }); + if ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Community') { + push(@rawmsg, { - mt =>'As Course Coordinator, use: [_1]Main Menu -> Manage Course Users -> Enrollment Requests[_1] to display a list of pending enrollment requests,[_1] which you can either approve or reject.', - args => ["\n"], + 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; @@ -149,7 +158,7 @@ sub send_selfserve_notification { my ($uname,$udom); if ($sender =~ /:/) { ($uname,$udom) = split(/:/,$sender); - } else { + } elsif ($context eq 'course') { $uname = $sender; my %courseinfo = &Apache::lonnet::coursedescription($cid); $udom = $courseinfo{'num'}; @@ -202,21 +211,23 @@ sub send_selfserve_notification { sub display_queued_requests { my ($context,$dom,$cnum) = @_; - my ($namespace,$formaction,%requesthash); + 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 = '
'. - ''. - ''. + $output = ''."\n". + ''."\n". + $nextelement."\n". &Apache::loncommon::start_data_table(). &Apache::loncommon::start_data_table_header_row(). ''.&mt('Action').''. @@ -243,7 +254,8 @@ sub display_queued_requests { } else { $timestamp = $requesthash{$item}{'timestamp'}; if (ref($requesthash{$item}) eq 'HASH') { - $entry = $item.':'.$requesthash{$item}{'ownername'}.':'. + my ($cnum,$disposition) = split('_',$item); + $entry = $cnum.':'.$requesthash{$item}{'ownername'}.':'. $requesthash{$item}{'ownerdom'}.':'. $requesthash{$item}{'crstype'}.':'. $requesthash{$item}{'description'}; @@ -280,7 +292,7 @@ sub display_queued_requests { $puname,$pudom); } else { - my ($cnum,$ownername,$ownerdom,$type,$cdesc)=split(/:/,$request); + my ($cnum,$ownername,$ownerdom,$type,$cdesc)=split(/:/,$request,5); $detailslink=''.$cdesc.''; $crstype = $type; @@ -329,11 +341,11 @@ sub display_queued_requests { sub update_request_queue { my ($context,$cdom,$cnum,$coursedesc) = @_; my ($output,$access_start,$access_end,$limit,$cap,$notifylist,$namespace, - $stucounts,$idx,$classlist,%requesthash,$coursedesc,$cid,$hostname, - $protocol,$now,$sender,$approvedmsg,$rejectedmsg,$beneficiary, - @existing,@missingreq,@invalidusers,@limitexceeded,@enrolled,@created, - @enrollerrors,@create_errors,@warn_approves,@warn_rejects,@approvals, - @rejections); + $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, + @rejections,@rejectionerrors,%courseroles,%communityroles,%domdefs); @approvals = &Apache::loncommon::get_env_multiple('form.approvereq'); @rejections = &Apache::loncommon::get_env_multiple('form.rejectreq'); $now = time; @@ -352,7 +364,6 @@ sub update_request_queue { $limit = $env{'course.'.$cid.'.internal.selfenroll_limit'}; $cap = $env{'course.'.$cid.'.internal.selfenroll_cap'}; $notifylist = $env{'course.'.$cid.'.internal.selfenroll_notifylist'}; - $namespace = 'selfenrollrequests'; ($stucounts,$idx,$classlist) = &get_student_counts($cdom,$cnum); $approvedmsg = [{ mt => 'Your request for enrollment has been approved.', @@ -365,7 +376,39 @@ sub update_request_queue { mt => 'Your request for enrollment has not been approved.', }]; } else { - $beneficiary = 'requestor'; + $domdesc = &Apache::lonnet::domain($cdom); + $namespace = 'courserequestqueue'; + $beneficiary = 'courserequestor'; + %requesthash = &Apache::lonnet::dump_dom($namespace,$cdom,undef,'_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'}; + } + } + $approvedmsg = [{ + mt => 'Your course request has been approved.', + }, + { + mt => 'Visit [_1], to log-in and access the course', + args => [$protocol.'://'.$hostname], + }]; + $rejectedmsg = [{ + mt => 'Your course 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') { @@ -402,46 +445,112 @@ sub update_request_queue { 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(@enrolled,$uname.':'.$udom); + push(@completed,$uname.':'.$udom); $stucounts->{'allstudents'} ++; $stucounts->{'selfenrolled'} ++; &send_selfserve_notification($uname.':'.$udom,$approvedmsg, $cid,$coursedesc,$now,$beneficiary,$sender); - my %userrequest; - if ($context eq 'course') { - %userrequest = ( - $cdom.'_'.$cnum => { - timestamp => $now, - section => $usec, - adjudicator => $env{'user.name'}.':'.$env{'user.domain'}, - status => 'approved', - } - ); - } else { - %userrequest = (); - } + 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(@enrollerrors,$uname.':'.$udom); + 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'}; + my $crstype = $requesthash{$cnum.'_approval'}{'crstype'}; + my $coursedesc = $requesthash{$cnum.'_approval'}{'description'}; + my $longroles = \%courseroles; + if ($crstype eq 'community') { + $longroles = \%communityroles; + } + if (&Apache::lonnet::usertools_access($ownername,$ownerdom,$crstype, + undef,'requestcourses')) { + 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') { + push(@completed,$cnum); + &send_selfserve_notification($ownername.':'.$ownerdom,$approvedmsg, + $cid,$coursedesc,$now,$beneficiary,$sender); + 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(@processing_errors,$cnum); + } + } else { + push(@existing,$cnum); + } + } else { + push(@missingreq,$cnum); + } } } - my @changes = (@enrolled,@rejections); + my @changes = (@completed,@rejections); + if ($context eq 'domain') { + @changes = map {$_.'_approval'} (@changes); + } if (@rejections) { - foreach my $user (@rejections) { - &send_selfserve_notification($user,$rejectedmsg,$cid,$coursedesc, - $now,$beneficiary,$sender); + foreach my $item (@rejections) { if ($context eq 'course') { + my $user = $item; + &send_selfserve_notification($user,$rejectedmsg,$cid,$coursedesc, + $now,$beneficiary,$sender); my ($uname,$udom) = split(/:/,$user); my %userrequest = ( $cdom.'_'.$cnum => { @@ -456,7 +565,54 @@ sub update_request_queue { 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'}; + &send_selfserve_notification($ownername.':'.$ownerdom,$rejectedmsg, + $cid,$coursedesc,$now,$beneficiary, + $sender); + 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); + } + } else { + push(@warn_rejects,$cnum); + } + } else { + push(@existing,$cnum); + } + } else { + push(@rejectionerrors,$cnum); + } } } } @@ -473,10 +629,10 @@ sub update_request_queue { my ($chgmsg,$approvedlist,$rejectedlist); if ($context eq 'course') { $chgmsg = "'Action was taken on the following enrollment requests by [_1].',$namelink"; - if (@enrolled) { - $approvedlist = join("\n",@enrolled); + if (@completed) { + $approvedlist = join("\n",@completed); $output .= '

'.&mt('The following were enrolled in the course:').'

'; } + 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:').'

'; + } + if (@rejections) { + $rejectedlist = join("\n",@rejections); + $output .= '

'.&mt('The following requests were rejected:').'

'; + } + if ($notifylist ne '') { + &send_selfserve_notification($notifylist,$chgmsg,$cid,$domdesc, + $now,'domainmanagers',$sender, + $approvedlist,$rejectedlist); + } } - &send_selfserve_notification($notifylist,$chgmsg,$cid,$coursedesc, - $now,'coursemanagers',$sender, - $approvedlist,$rejectedlist); } } if (@existing) { @@ -509,7 +701,18 @@ sub update_request_queue { } $output .= '

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

'.&mt('The following course creation requests were deleted because the course has already been created:').'

'; } } if (@missingreq) { @@ -519,6 +722,13 @@ sub update_request_queue { $output .= '
  • '.$user.'
  • '; } $output .= '

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

    '.&mt('The following course creation requests were ignored because the request is no longer in the course request queue:').'

    '; + } } if (@invalidusers) { @@ -528,8 +738,6 @@ sub update_request_queue { $output .= '
  • '.$user.'
  • '; } $output .= '

    '; - } else { - } } if (@limitexceeded) { @@ -539,41 +747,61 @@ sub update_request_queue { $output .= '
  • '.$user.'
  • '; } $output .= '

    '; - } else { - } } - if (@enrollerrors) { + if (@processing_errors) { if ($context eq 'course') { $output .= '

    '.&mt('The following enrollment requests could not be processed because an error occurred:').'

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

    '.&mt('The following course creation requests could not be processed because an error occurred:').'

    '; } } - if (@warn_approves) { - if ($context eq 'course') { - $output .= '

    '.&mt("For the following users, an error occurred when updating the user's own self-enroll requests record:").'

    '; } - if (@warn_rejects) { + if (@warn_approves || @warn_rejects) { if ($context eq 'course') { $output .= '

    '.&mt("For the following users, an error occurred when updating the user's own self-enroll requests record:").'

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

    '.&mt("For the following course requests an error occurred when updating the requestor's own course requests record:").'

    '; } } return $output; @@ -597,4 +825,100 @@ sub get_student_counts { 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 $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 $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,$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 = &Apache::lonnet::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'; + } + $batchhash{'users'}{$details->{$owner}} = { + firstname => $env{'environment.first'}, + lastname => $env{'environment.last'}, + emailenc => $emailenc, + email => $owneremail, + }; + } + return %batchhash; +} + +sub can_clone_course { + my ($uname,$udom,$clonecrs,$clonedom) = @_; + my $canclone; + my %roleshash = &Apache::lonnet::get_my_roles($uname,$udom,'userroles',['active'], + ['cc'],[$clonedom]); + if (exists($roleshash{$clonedom.':'.$clonecrs.':cc'})) { + $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; + } + } + } + return $canclone; +} + 1;