--- loncom/interface/loncreateuser.pm 2009/02/03 05:28:00 1.276 +++ loncom/interface/loncreateuser.pm 2009/02/18 19:34:08 1.282 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Create a user # -# $Id: loncreateuser.pm,v 1.276 2009/02/03 05:28:00 raeburn Exp $ +# $Id: loncreateuser.pm,v 1.282 2009/02/18 19:34:08 schafran 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 @@ -226,9 +227,9 @@ sub build_tools_display { 'official' => 'Can request creation of official courses', 'unofficial' => 'Can request creation of unofficial courses', ); - if ($context eq 'requestcourse') { + if ($context eq 'requestcourses') { %userenv = &Apache::lonnet::userenvironment($ccdomain,$ccuname, - 'requestcourse.official','requestcourse.unofficial'); + 'requestcourses.official','requestcourses.unofficial'); @usertools = ('official','unofficial'); } else { %userenv = &Apache::lonnet::userenvironment($ccdomain,$ccuname, @@ -336,7 +337,7 @@ sub print_username_entry_form { 'dom' => "Domain", 'ecrp' => "Edit Custom Role Privileges", 'nr' => "Name of Role", - 'cre' => "Custom Role Editor", + 'cre' => "Next", ); $r->print($start_page."\n".$crumbs); if ($env{'form.action'} eq 'custom') { @@ -346,7 +347,7 @@ sub print_username_entry_form {

$lt{'ecrp'}

-$lt{'nr'}: $choice
+$choice $lt{'nr'}:
ENDCUSTOM @@ -869,7 +870,7 @@ ENDCHANGEUSER if (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'})) { $r->print('

'.&mt('User Can Request Creation of Courses?').'

'. &Apache::loncommon::start_data_table(). - &build_tools_display($ccuname,$ccdomain,'requestcourse'). + &build_tools_display($ccuname,$ccdomain,'requestcourses'). &Apache::loncommon::end_data_table()); } $r->print(''); @@ -1712,8 +1713,8 @@ sub update_user_data { } if ( $env{'form.ccuname'} ne &LONCAPA::clean_username($env{'form.ccuname'}) ) { - $r->print($error.&mt('Invalid login name').'. '. - &mt('Only letters, numbers, periods, dashes, @, and underscores are valid').'.'. + $r->print($error.&mt('Invalid login name.').' '. + &mt('Only letters, numbers, periods, dashes, @, and underscores are valid.'). $end.$rtnlink); return; } @@ -1723,8 +1724,8 @@ sub update_user_data { } if ( $env{'form.ccdomain'} ne &LONCAPA::clean_domain($env{'form.ccdomain'}) ) { - $r->print($error.&mt ('Invalid domain name').'. '. - &mt('Only letters, numbers, periods, dashes, and underscores are valid').'.'. + $r->print($error.&mt('Invalid domain name.').' '. + &mt('Only letters, numbers, periods, dashes, and underscores are valid.'). $end.$rtnlink); return; } @@ -1850,12 +1851,10 @@ sub update_user_data { \%changeHash,'tools'); } } - if (&Apache::lonnet::allowed('ccc',$env{'request.domain'})) { - foreach my $item (@requestcourses) { - $newcustom{$item} = $env{'form.requestcourse_'.$item}; - $changed{$item} = &tool_admin($item,$newcustom{$item}, - \%changeHash,'requestcourse'); - } + foreach my $item (@requestcourses) { + $newcustom{$item} = $env{'form.requestcourses_'.$item}; + $changed{$item} = &tool_admin($item,$newcustom{$item}, + \%changeHash,'requestcourses'); } if (keys(%changed)) { $changeHash{'firstname'} = $env{'form.cfirstname'}; @@ -1901,8 +1900,8 @@ sub update_user_data { my %userenv = &Apache::lonnet::get ('environment',['firstname','middlename','lastname','generation', 'id','permanentemail','portfolioquota','inststatus','tools.aboutme', - 'tools.blog','tools.portfolio','requestcourse.official', - 'requestcourse.unofficial'], + 'tools.blog','tools.portfolio','requestcourses.official', + 'requestcourses.unofficial'], $env{'form.ccdomain'},$env{'form.ccuname'}); my ($tmp) = keys(%userenv); if ($tmp =~ /^(con_lost|error)/i) { @@ -2083,7 +2082,7 @@ sub update_user_data { } &tool_changes('tools',\@usertools,\%oldaccess,\%oldaccesstext,\%userenv, \%changeHash,\%changed,\%newaccess,\%newaccesstext); - &tool_changes('requestcourse',\@requestcourses,\%oldaccess,\%oldaccesstext, + &tool_changes('requestcourses',\@requestcourses,\%oldaccess,\%oldaccesstext, \%userenv, \%changeHash,\%changed,\%newaccess,\%newaccesstext); if ($env{'form.cfirstname'} ne $userenv{'firstname'} || $env{'form.cmiddlename'} ne $userenv{'middlename'} || @@ -2111,16 +2110,26 @@ sub update_user_data { my %newenvhash; foreach my $key (keys(%changed)) { if (($key eq 'official') || ($key eq 'unofficial')) { - $newenvhash{'environment.canrequest.'.$key} = - $changeHash{'requestcourse.'.$key}; - $newenvhash{'environment.canrequest.'.$key} = - $changeHash{'requestcourse.'.$key}; - + $newenvhash{'environment.requestcourses.'.$key} = + $changeHash{'requestcourses.'.$key}; + if ($changeHash{'requestcourses.'.$key} ne '') { + $newenvhash{'environment.canrequest.'.$key} = + $changeHash{'requestcourses.'.$key}; + } else { + $newenvhash{'environment.canrequest.'.$key} = + &Apache::lonnet::usertools_access($env{'user.name'},$env{'user.domain'}, + $key,'reload','requestcourses'); + } } elsif ($key ne 'quota') { $newenvhash{'environment.tools.'.$key} = $changeHash{'tools.'.$key}; - $newenvhash{'environment.availabletools.'.$key} = - $changeHash{'tools.'.$key}; + if ($changeHash{'tools.'.$key} ne '') { + $newenvhash{'environment.availabletools.'.$key} = + $changeHash{'tools.'.$key}; + } else { + $newenvhash{'environment.availabletools.'.$key} = + &Apache::lonnet::usertools_access($env{'user.name'},$env{'user.domain'}, $key,'reload','tools'); + } } } if (keys(%newenvhash)) { @@ -2396,9 +2405,9 @@ sub tool_changes { } else { $oldaccesstext->{$tool} = &mt("availability set to 'off'"); } - $changeHash->{$context.'.'.$tool} = $userenv->{'tools.'.$tool}; + $changeHash->{$context.'.'.$tool} = $userenv->{$context.'.'.$tool}; if ($env{'form.custom'.$tool} == 1) { - if ($env{'form.'.$context.'_'.$tool} ne $userenv->{'tools.'.$tool}) { + if ($env{'form.'.$context.'_'.$tool} ne $userenv->{$context.'.'.$tool}) { $changed->{$tool} = &tool_admin($tool,$env{'form.'.$context.'_'.$tool}, $changeHash,$context); if ($changed->{$tool}) { @@ -2822,7 +2831,7 @@ sub quota_admin { sub tool_admin { my ($tool,$settool,$changeHash,$context) = @_; my $canchange = 0; - if ($context eq 'requestcourse') { + if ($context eq 'requestcourses') { if (&Apache::lonnet::allowed('ccc',$env{'form.ccdomain'})) { $canchange = 1; } @@ -3008,7 +3017,7 @@ ENDCCF ''."\n".''."\n". ''."\n". - ''. + ''. &Apache::loncommon::end_page()); } # -------------------------------------------------------- @@ -3409,6 +3418,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 +3583,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'})){ @@ -3982,7 +4024,7 @@ ENDSCRIPT } } if (@ccs) { - $output .= '
'.&mt('Personnel to be notified when a self-enrollment request needs approval, or has been approved:').' '.&Apache::loncommon::start_data_table(). + $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; @@ -4031,7 +4073,7 @@ ENDSCRIPT $selflimit = ' '; } $output .= ''. + ''. + ''. + ''. + &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(). + ''. + ''. + ''. + ''. + &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,@warn_approves,@warn_rejects); + 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); + 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); + } + } + } 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); + 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); + } + } + } + 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:').'

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

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

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

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

'); + } + 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); @@ -4063,7 +4378,7 @@ sub visible_in_cat { miss => 'Your course does not currently appear in the Course Catalog for this domain.', yous => 'You should remedy this if you plan to allow self-enrollment, otherwise students will have difficulty finding your course.', coca => 'Courses can be absent from the Catalog, because they do not have an institutional code, have no assigned category, or have been specifically excluded.', - make => 'Make any changes to self-enrollment settings below, click "Save changes", then take action to include the course in the Catalog:', + make => 'Make any changes to self-enrollment settings below, click "Save", then take action to include the course in the Catalog:', take => 'Take the following action to ensure the course appears in the Catalog:', dc_unhide => 'Ask a domain coordinator to change the "Exclude from course catalog" setting.', dc_addinst => 'Ask a domain coordinator to enable display the catalog of "Official courses (with institutional codes)".', @@ -5438,9 +5753,9 @@ sub update_selfenroll_config { } $r->print('
  • '.&mt('"[_1]" set to "[_2]".',$title,$newval)); if ($newnotify) { - $r->print('
    '.&mt('The following will be notified when a self-enrollment request needs approval, or has been approved: [_1].',$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 a self-enrollment request needs approval, or has been approved.')); + $r->print('
    '.&mt('No notifications sent when an enrollment request needs approval, or has been approved.')); } $r->print('
    • '."\n"); }
    '.&mt('Action').''.&mt('Requestor').''.&mt('Section').''.&mt('Date requested').'
    '. + '
    		'.$namelink.''.$showsec.''.&Apache::lonlocal::locallocaltime($item).'