--- loncom/interface/loncreateuser.pm 2009/02/02 00:12:01 1.275 +++ loncom/interface/loncreateuser.pm 2009/02/05 12:19:50 1.277 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Create a user # -# $Id: loncreateuser.pm,v 1.275 2009/02/02 00:12:01 raeburn Exp $ +# $Id: loncreateuser.pm,v 1.277 2009/02/05 12:19:50 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -68,6 +68,7 @@ use Apache::loncommon; use Apache::lonlocal; use Apache::longroup; use Apache::lonuserutils; +use Apache::selfenroll(); use LONCAPA qw(:DEFAULT :match); my $loginscript; # piece of javascript used in two separate instances @@ -3409,6 +3410,29 @@ sub handler { &update_selfenroll_config($r,$context,$permission); } $r->print(&Apache::loncommon::end_page()); + } elsif ($env{'form.action'} eq 'selfenrollqueue') { + $r->print(&header()); + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/createuser?action=selfenrollqueue', + text=>"Enrollment requests"}); + my $cid = $env{'request.course.id'}; + my $cdom = $env{'course.'.$cid.'.domain'}; + my $cnum = $env{'course.'.$cid.'.num'}; + if (!exists($env{'form.state'})) { + $r->print(&Apache::lonhtmlcommon::breadcrumbs('Enrollment requests', + 'Course_SelfEnrollment_Approval')); + $r->print('

'.&mt('Pending enrollment requests').'

'."\n"); + &display_selfenroll_queue($r,$context,$permission,$cnum,$cdom); + } elsif ($env{'form.state'} eq 'done') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/createuser?action=selfenrollqueue', + text=>"Result"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs('Enrollment result', + 'Course_Self_Enrollment')); + $r->print('

'.&mt('Enrollment request processing').'

'."\n"); + &update_selfenroll_queue($r,$context,$permission,$cid,$cnum,$cdom); + } + $r->print(&Apache::loncommon::end_page()); } elsif ($env{'form.action'} eq 'changelogs') { $r->print(&header()); &Apache::lonhtmlcommon::add_breadcrumb @@ -3551,6 +3575,16 @@ sub print_main_menu { permission => $permission->{'custom'}, linktitle => 'Configure a custom role.', }); + if ($env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_approval'}) { + push(@{ $menu[1]->{items} }, + { linktext => 'Enrollment Requests', + icon => 'selfenrl-queue.png', + #help => 'Course_Approve_Selfenroll', + url => '/adm/createuser?action=selfenrollqueue', + permission => $permission->{'cusr'}, + linktitle =>'Approve or reject enrollment requests.', + }); + } if (!exists($permission->{'cusr_section'})){ @@ -3952,6 +3986,95 @@ ENDSCRIPT ''."\n". ''."\n". ''."\n"; + } elsif ($item eq 'approval') { + my ($appon,$appoff); + my $cid = $env{'request.course.id'}; + my $currnotified = $env{'course.'.$cid.'.internal.selfenroll_notifylist'}; + if ($env{'course.'.$cid.'.internal.selfenroll_approval'}) { + $appon = ' checked="checked" '; + $appoff = ' '; + } else { + $appon = ' '; + $appoff = ' checked="checked" '; + } + $output .= '  '; + my %advhash = &Apache::lonnet::get_course_adv_roles($cid,1); + my (@ccs,%notified); + if ($advhash{'cc'}) { + @ccs = split(/,/,$advhash{'cc'}); + } + if ($currnotified) { + foreach my $current (split(/,/,$currnotified)) { + $notified{$current} = 1; + if (!grep(/^\Q$current\E$/,@ccs)) { + push(@ccs,$current); + } + } + } + if (@ccs) { + $output .= '
'.&mt('Personnel to be notified when an enrollment request needs approval, or has been approved:').' '.&Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_row(); + my $count = 0; + my $numcols = 4; + foreach my $cc (sort(@ccs)) { + my $notifyon; + my ($ccuname,$ccudom) = split(/:/,$cc); + if ($notified{$cc}) { + $notifyon = ' checked="checked" '; + } + if ($count && !$count%$numcols) { + $output .= &Apache::loncommon::end_data_table_row(). + &Apache::loncommon::start_data_table_row() + } + $output .= ''; + $count; + } + my $rem = $count%$numcols; + if ($rem) { + my $emptycols = $numcols - $rem; + for (my $i=0; $i<$emptycols; $i++) { + $output .= ' '; + } + } + $output .= &Apache::loncommon::end_data_table_row(). + &Apache::loncommon::end_data_table(); + } + } elsif ($item eq 'limit') { + my ($crslimit,$selflimit,$nolimit); + my $cid = $env{'request.course.id'}; + my $currlim = $env{'course.'.$cid.'.internal.selfenroll_limit'}; + my $currcap = $env{'course.'.$cid.'.internal.selfenroll_cap'}; + my $nolimit = ' checked="checked" '; + if ($currlim eq 'allstudents') { + $crslimit = ' checked="checked" '; + $selflimit = ' '; + $nolimit = ' '; + } elsif ($currlim eq 'selfenrolled') { + $crslimit = ' '; + $selflimit = ' checked="checked" '; + $nolimit = ' '; + } else { + $crslimit = ' '; + $selflimit = ' '; + } + $output .= ''. + '
 '. + (' 'x3).&mt('Maximum number allowed: '). + '
'; } $output .= &Apache::lonhtmlcommon::row_closure(1); } @@ -3964,6 +4087,238 @@ ENDSCRIPT return; } +sub display_selfenroll_queue { + my ($r,$context,$permission,$cnum,$cdom) = @_; + my $namespace = 'selfenrollrequests'; + my ($output,%queue_by_date); + my %requesthash = &Apache::lonnet::dump($namespace,$cdom,$cnum); + if (keys(%requesthash) > 0) { + $r->print('
'. + ''. + ''. + &Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_header_row(). + ''.&mt('Action').''. + ''.&mt('Requestor').''. + ''.&mt('Section').''. + ''.&mt('Date requested').''. + &Apache::loncommon::end_data_table_header_row()); + foreach my $item (keys(%requesthash)) { + my ($timestamp,$usec) = split(/:/,$requesthash{$item}); + if (exists($queue_by_date{$timestamp})) { + if (ref($queue_by_date{$timestamp}) eq 'ARRAY') { + push(@{$queue_by_date{$timestamp}},$item.':'.$usec); + } + } else { + @{$queue_by_date{$timestamp}} = ($item.':'.$usec); + } + } + 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 ($puname,$pudom,$pusec) = split(/:/,$request); + my $showsec = $pusec; + if ($showsec eq '') { + $showsec = &mt('none'); + } + my $namelink = &Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($puname,$pudom), + $puname,$pudom); + $r->print(&Apache::loncommon::start_data_table_row(). + '
'. + '
'. + ''.$namelink.''. + ''.$showsec.''. + ''.&Apache::lonlocal::locallocaltime($item).''. + &Apache::loncommon::end_data_table_row()); + $count ++; + } + } + } + $r->print(&Apache::loncommon::end_data_table(). + '
'); + } else { + $r->print(&mt('There are currently no enrollment requests.')); + } + return; +} + +sub update_selfenroll_queue { + my ($r,$context,$permission,$cid,$cnum,$cdom) = @_; + my @approvals = &Apache::loncommon::get_env_multiple('form.approvereq'); + my @rejections = &Apache::loncommon::get_env_multiple('form.rejectreq'); + my $access_start = $env{'course.'.$cid.'.internal.selfenroll_start_access'}; + my $access_end = $env{'course.'.$cid.'.internal.selfenroll_end_access'}; + my $limit = $env{'course.'.$cid.'.internal.selfenroll_limit'}; + my $cap = $env{'course.'.$cid.'.internal.selfenroll_cap'}; + my $notifylist = $env{'course.'.$cid.'.internal.selfenroll_notifylist'}; + my $namespace = 'selfenrollrequests'; + my ($stucounts,$idx,$classlist) = &get_student_counts($cdom,$cnum); + my %requesthash = &Apache::lonnet::dump($namespace,$cdom,$cnum); + my $coursedesc = $env{'course.'.$cid.'.description'}; + my $chome = &Apache::lonnet::homeserver($cnum,$cdom); + my $hostname = &Apache::lonnet::hostname($chome); + my $protocol = $Apache::lonnet::protocol{$chome}; + $protocol = 'http' if ($protocol ne 'https'); + my (@existing,@missingreq,@invalidusers,@limitexceeded,@enrolled,@enrollerrors,); + my $now = time; + my $sender = $env{'user.name'}.':'.$env{'user.domain'}; + my $approvedmsg = [{ + mt => 'Your request for enrollment has been approved.', + }, + { + mt => 'Visit [_1], to log-in and access the course', + args => [$protocol.'://'.$hostname], + }]; + + my $rejectedmsg = [{ + mt => 'Your request for enrollment has not been approved.', + }]; + foreach my $item (sort {$a <=> $b} @approvals) { + 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(@enrolled,$uname.':'.$udom); + $stucounts->{'allstudents'} ++; + $stucounts->{'selfenrolled'} ++; + &Apache::selfenroll::send_notification($uname.':'.$udom,$approvedmsg,$cid, + $coursedesc,$now,'enroller',$sender); + } else { + push(@enrollerrors,$uname.':'.$udom); + } + } + } else { + push(@invalidusers,$uname.':'.$udom); + } + } + my @changes = (@enrolled,@rejections); + if (@rejections) { + foreach my $user (@rejections) { + &Apache::selfenroll::send_notification($user,$rejectedmsg,$cid, + $coursedesc,$now,'enroller',$sender); + } + } + if (@changes) { + my $delresult = &Apache::lonnet::del($namespace,\@changes,$cdom,$cnum); + if ($delresult eq 'ok') { + my $namelink = + &Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'}).' ('.$env{'user.name'}.':'.$env{'user.domain'}.')'; + my $chgmsg = "'Action was taken on the following enrollment requests by [_1].',$namelink"; + my ($approvedlist,$rejectedlist); + if (@enrolled) { + $approvedlist = join("\n",@enrolled); + $r->print('

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

'); + } + if (@rejections) { + $rejectedlist = join("\n",@rejections); + $r->print('

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

'); + } + &Apache::selfenroll::send_notification($notifylist,$chgmsg,$cid, + $coursedesc,$now,'managers', + $sender,$approvedlist,$rejectedlist); + } + } + if (@existing) { + $r->print('

'.&mt('The following enrollment requests were deleted because the user is already enrolled in the course:').'

'); + } + if (@missingreq) { + $r->print('

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

'); + } + if (@invalidusers) { + $r->print('

'.&mt('The following enrollment requests were deleted because the requestor does not have a LON-CAPA account:').'

'); + } + if (@limitexceeded) { + $r->print('

'.&mt('The following enrollment requests were skipped because the enrollment limit has been reached for the course:').'

'); + } + if (@enrollerrors) { + $r->print('

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

'); + } + return; +} + +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 visible_in_cat { my ($cdom,$cnum) = @_; my %domconf = &Apache::lonnet::get_dom('configuration',['coursecategories'],$cdom); @@ -5159,6 +5514,74 @@ sub update_selfenroll_config { $changes{'internal.selfenroll_types'} = $selfenroll_types; } } + } elsif ($item eq 'limit') { + my $newlimit = $env{'form.selfenroll_limit'}; + my $newcap = $env{'form.selfenroll_cap'}; + $newcap =~s/\s+//g; + my $currlimit = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_limit'}; + $currlimit = 'none' if ($currlimit eq ''); + my $currcap = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_cap'}; + if ($newlimit ne $currlimit) { + if ($newlimit ne 'none') { + if ($newcap =~ /^\d+$/) { + if ($newcap ne $currcap) { + $changes{'internal.selfenroll_cap'} = $newcap; + } + $changes{'internal.selfenroll_limit'} = $newlimit; + } else { + $warning{$item} = &mt('Maximum enrollment setting unchanged.').'
'.&mt('The value provided was invalid - it must be a positive integer if enrollment is being limited.'); + } + } elsif ($currcap ne '') { + $changes{'internal.selfenroll_cap'} = ''; + $changes{'internal.selfenroll_limit'} = $newlimit; + } + } elsif ($currlimit ne 'none') { + if ($newcap =~ /^\d+$/) { + if ($newcap ne $currcap) { + $changes{'internal.selfenroll_cap'} = $newcap; + } + } else { + $warning{$item} = &mt('Maximum enrollment setting unchanged.').'
'.&mt('The value provided was invalid - it must be a positive integer if enrollment is being limited.'); + } + } + } elsif ($item eq 'approval') { + my (@currnotified,@newnotified); + my $currapproval = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_approval'}; + my $currnotifylist = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_notifylist'}; + if ($currnotifylist ne '') { + @currnotified = split(/,/,$currnotifylist); + @currnotified = sort(@currnotified); + } + my $newapproval = $env{'form.selfenroll_approval'}; + @newnotified = &Apache::loncommon::get_env_multiple('form.selfenroll_notify'); + @newnotified = sort(@newnotified); + if ($newapproval ne $currapproval) { + $changes{'internal.selfenroll_approval'} = $newapproval; + if (!$newapproval) { + if ($currnotifylist ne '') { + $changes{'internal.selfenroll_notifylist'} = ''; + } + } else { + my @differences = + &compare_arrays(\@currnotified,\@newnotified); + if (@differences > 0) { + if (@newnotified > 0) { + $changes{'internal.selfenroll_notifylist'} = join(',',@newnotified); + } else { + $changes{'internal.selfenroll_notifylist'} = join(',',@newnotified); + } + } + } + } else { + my @differences = &compare_arrays(\@currnotified,\@newnotified); + if (@differences > 0) { + if (@newnotified > 0) { + $changes{'internal.selfenroll_notifylist'} = join(',',@newnotified); + } else { + $changes{'internal.selfenroll_notifylist'} = ''; + } + } + } } else { my $curr_val = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_'.$item}; @@ -5231,6 +5654,62 @@ sub update_selfenroll_config { $title,$type,$newdate).''); } } + } elsif ($item eq 'limit') { + if ((exists($changes{'internal.selfenroll_limit'})) || + (exists($changes{'internal.selfenroll_cap'}))) { + my ($newval,$newcap); + if ($changes{'internal.selfenroll_cap'} ne '') { + $newcap = $changes{'internal.selfenroll_cap'} + } else { + $newcap = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_cap'}; + } + if ($changes{'internal.selfenroll_limit'} eq 'none') { + $newval = &mt('No limit'); + } elsif ($changes{'internal.selfenroll_limit'} eq + 'allstudents') { + $newval = &mt('New self-enrollment no longer allowed when total (all students) reaches [_1].',$newcap); + } elsif ($changes{'internal.selfenroll_limit'} eq 'selfenrolled') { + $newval = &mt('New self-enrollment no longer allowed when total number of self-enrolled students reaches [_1].',$newcap); + } else { + my $currlimit = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_limit'}; + if ($currlimit eq 'allstudents') { + $newval = &mt('New self-enrollment no longer allowed when total (all students) reaches [_1].',$newcap); + } elsif ($changes{'internal.selfenroll_limit'} eq 'selfenrolled') { + $newval = &mt('New self-enrollment no longer allowed when total umber of self-enrolled students reaches [_1].',$newcap); + } + } + $r->print('
  • '.&mt('"[_1]" set to "[_2]".',$title,$newval).'
    • '."\n"); + } + } elsif ($item eq 'approval') { + if ((exists($changes{'internal.selfenroll_approval'})) || + (exists($changes{'internal.selfenroll_notifylist'}))) { + my ($newval,$newnotify); + if (exists($changes{'internal.selfenroll_notifylist'})) { + $newnotify = $changes{'internal.selfenroll_notifylist'}; + } else { + $newnotify = $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_notifylist'}; + } + if ($changes{'internal.selfenroll_approval'}) { + $newval = &mt('Yes'); + } elsif ($changes{'internal.selfenroll_approval'} eq '0') { + $newval = &mt('No'); + } else { + my $currapproval = + $env{'course.'.$env{'request.course.id'}.'.internal.selfenroll_approval'}; + if ($currapproval) { + $newval = &mt('Yes'); + } else { + $newval = &mt('No'); + } + } + $r->print('
  • '.&mt('"[_1]" set to "[_2]".',$title,$newval)); + if ($newnotify) { + $r->print('
    '.&mt('The following will be notified when an enrollment request needs approval, or has been approved: [_1].',$newnotify)); + } else { + $r->print('
    '.&mt('No notifications sent when an enrollment request needs approval, or has been approved.')); + } + $r->print('
    • '."\n"); + } } else { if (exists($changes{'internal.selfenroll_'.$item})) { my $newval = $changes{'internal.selfenroll_'.$item}; @@ -5284,14 +5763,33 @@ sub update_selfenroll_config { return; } +sub compare_arrays { + my ($arrayref1,$arrayref2) = @_; + my (@difference,%count); + @difference = (); + %count = (); + if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) { + foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; } + foreach my $element (keys(%count)) { + if ($count{$element} == 1) { + push(@difference,$element); + } + } + } + return @difference; +} + sub get_selfenroll_titles { - my @row = ('types','registered','enroll_dates','access_dates','section'); + my @row = ('types','registered','enroll_dates','access_dates','section', + 'approval','limit'); my %lt = &Apache::lonlocal::texthash ( types => 'Users allowed to self-enroll in this course', registered => 'Restrict self-enrollment to students officially registered for the course', enroll_dates => 'Dates self-enrollment available', access_dates => 'Course access dates assigned to self-enrolling users', section => 'Section assigned to self-enrolling users', + approval => 'Self-enrollment requests need approval?', + limit => 'Enrollment limit', ); return (\@row,\%lt); }