--- loncom/enrollment/Enrollment.pm 2014/06/23 00:56:02 1.47 +++ loncom/enrollment/Enrollment.pm 2021/09/08 12:13:13 1.55 @@ -1,5 +1,5 @@ # Automated Enrollment manager -# $Id: Enrollment.pm,v 1.47 2014/06/23 00:56:02 raeburn Exp $ +# $Id: Enrollment.pm,v 1.55 2021/09/08 12:13:13 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -31,7 +31,9 @@ use Apache::loncommon(); use Apache::lonmsg; use Apache::lonlocal; use HTML::Entities; +use HTML::Parser; use LONCAPA::Configuration; +use Math::Random; use Time::Local; use lib '/home/httpd/lib/perl'; @@ -39,8 +41,8 @@ use strict; sub update_LC { my ($dom,$crs,$adds,$drops,$startdate,$enddate,$authtype,$autharg, - $showcredits,$defaultcredits,$classesref,$groupref,$logmsg,$newusermsg, - $context,$phototypes) = @_; + $showcredits,$defaultcredits,$autofailsafe,$classesref,$groupref, + $logmsg,$newusermsg,$context,$phototypes) = @_; # Get institutional code and title of this class my %courseinfo = (); &get_courseinfo($dom,$crs,\%courseinfo); @@ -56,6 +58,7 @@ sub update_LC { my $type=&Apache::loncoursedata::CL_TYPE; my $lockedtype=&Apache::loncoursedata::CL_LOCKEDTYPE; my $credidx=&Apache::loncoursedata::CL_CREDITS; + my $instidx = &Apache::loncoursedata::CL_INSTSEC; my @localstudents = (); my @futurestudents = (); my @activestudents = (); @@ -130,9 +133,11 @@ sub update_LC { my %place = &place_hash(); my %ucount = (); my %enrollinfo = (); + my %classcount; foreach my $class (@{$classesref}) { my %enrolled = (); &parse_classlist($$configvars{'lonDaemons'},$dom,$crs,$class,\%place,$$groupref{$class},\%enrolled); + $classcount{$class} = scalar(keys(%enrolled)); foreach my $uname (sort keys %enrolled ) { if (!grep/^$uname$/,@reg_students) { push @reg_students,$uname; @@ -197,9 +202,11 @@ sub update_LC { } } -# Explicitly allow access to creation/modification of students if called as an automated process. +# Explicitly allow access to creation/modification of students and group membership changes +# when called as an automated process. if ($context eq 'automated') { $env{'allowed.cst'}='F'; + $env{'allowed.mdg'}='F'; } # Compare IDs with existing LON-CAPA enrollment for this class @@ -207,7 +214,7 @@ sub update_LC { unless ($uname eq '') { my %uidhash=&Apache::lonnet::idrget($dom,$uname); my @stuinfo = @{$enrollinfo{$uname}}; - my ($access,$added,$inststatus); + my ($access,$added,$inststatus,$instsec); my $credits; if ($showcredits) { $credits = $stuinfo[$place{'credits'}]; @@ -217,6 +224,7 @@ sub update_LC { } } $inststatus = $stuinfo[$place{inststatus}]; + $instsec = $stuinfo[$place{instsec}]; if (grep/^$uname$/,@localstudents) { # Check for studentID changes if ( ($uidhash{$uname}) && ($uidhash{$uname} !~ /error\:/) ) { @@ -253,7 +261,7 @@ sub update_LC { &execute_add($context,'switchtype',$uname,$dom,$auth, $authparam,$first,$middle,$last,$gene, $pid,$usec,$end,$start,$emailenc, - $credits,$cid,\$addresult,\$enrollcount, + $credits,$instsec,$cid,\$addresult,\$enrollcount, $linefeed,$logmsg); $added = 1; } @@ -264,7 +272,7 @@ sub update_LC { if ( (grep/^$uname$/,@futurestudents) && ($$currlist{$uname}[$type] eq "auto") && ($adds == 1) ) { my $datechange = &datechange_check($$currlist{$uname}[$cstart],$$currlist{$uname}[$cend],$startdate,$enddate); if ($datechange) { - my $modify_access_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits); + my $modify_access_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits,$instsec); $access = &showaccess($enddate,$startdate); if ($modify_access_result =~ /^ok/) { $$logmsg .= &mt('Change in access dates for [_1].',$uname).$access.$linefeed; @@ -287,9 +295,9 @@ sub update_LC { if ($expire_role_result eq 'ok') { my $modify_section_result; if (grep/^$uname$/,@activestudents) { - $modify_section_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$$currlist{$uname}[$cend],$$currlist{$uname}[$cstart],'auto','',$cid,'',$context,$credits); + $modify_section_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$$currlist{$uname}[$cend],$$currlist{$uname}[$cstart],'auto','',$cid,'',$context,$credits,$instsec); } else { - $modify_section_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits); + $modify_section_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits,$instsec); $access = &showaccess($enddate,$startdate); } if ($modify_section_result =~ /^ok/) { @@ -311,7 +319,7 @@ sub update_LC { if (($showcredits) && ($$currlist{$uname}[$credidx] ne $credits) && (!$added)) { my $modify_credits_result = - &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits); + &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits,$instsec); if ($modify_credits_result =~ /^ok/) { if ($credits ne '') { $$logmsg .= &mt('Credits change for [_1] from [_2] to [_3].',$uname,$$currlist{$uname}[$credidx],$credits).$linefeed; @@ -322,6 +330,16 @@ sub update_LC { $$logmsg .= &mt('Error when attempting to change credits for [_1] in section: [_2] -error [_3].',$uname,$stuinfo[$place{groupID}],$modify_credits_result).$linefeed; } } +# Check for institutional section change + if (($$currlist{$uname}[$instidx] ne $instsec) && (!$added) && ($$currlist{$uname}[$type] eq "auto")) { + my $modify_instsec_result = + &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits,$instsec); + if ($modify_instsec_result =~ /^ok/) { + $$logmsg .= &mt('Institutional section change for [_1] from [_2] to [_3].',$uname,$$currlist{$uname}[$instidx],$instsec).$linefeed; + } else { + $$logmsg .= &mt('Error when attempting to change institutional section for [_1] in section: [_2] -error [_3].',$uname,$stuinfo[$place{groupID}],$modify_instsec_result).$linefeed; + } + } } else { # Check for changed usernames by checking studentIDs if ( ($stuinfo[ $place{studentID} ] ne '') && (grep/^$stuinfo[ $place{studentID} ]$/,@LCids) ) { @@ -363,6 +381,7 @@ sub update_LC { 'context' => $context, 'linefeed' => $linefeed, 'inststatus' => $inststatus, + 'instsec' => $instsec, 'role' => 'st', }; if ($credits) { @@ -372,7 +391,7 @@ sub update_LC { } else { &execute_add($context,'newstudent',$uname,$dom,$auth, $authparam,$first,$middle,$last,$gene,$pid, - $usec,$end,$start,$emailenc,$credits, + $usec,$end,$start,$emailenc,$credits,$instsec, $cid,\$addresult,\$enrollcount,$linefeed, $logmsg); } @@ -418,6 +437,7 @@ sub update_LC { # Do drops if ( ($drops == 1) && (@reg_students > 0) ) { + my %delaydrops; foreach my $uname (@localstudents) { if ($$currlist{$uname}[$type] eq "auto") { my @saved = (); @@ -425,10 +445,21 @@ sub update_LC { # Check for changed usernames by checking studentIDs if (grep/^$$currlist{$uname}[ $stuid ]$/,@allINids) { foreach my $match (@{$unameFromINid{$$currlist{$uname}[ $stuid ]}} ) { - $$logmsg .= &mt('A possible change in username has been detected for a student enrolled in this course.').' '.&mt('The existing LON-CAPA classlist contains user: [_1] and student/employee ID: [_2].',$uname,$$currlist{$uname}[ $place{studentID} ]).' '.&mt('This username has been dropped from the institutional classlist, but the same student/employee ID is used for user: [_1] who still appears in the institutional classlist.',$match).' '.&mt('You may need to move the student data files for user: [_1] to [_2]',$uname,$match).' '.&mt('Because of this, user [_1] has not been dropped from the course.',$uname).$linefeed; + $$logmsg .= &mt('A possible change in username has been detected for a student enrolled in this course.').' '.&mt('The existing LON-CAPA classlist contains user: [_1] and student/employee ID: [_2].',$uname,$$currlist{$uname}[ $stuid ]).' '.&mt('This username has been dropped from the institutional classlist, but the same student/employee ID is used for user: [_1] who still appears in the institutional classlist.',$match).' '.&mt('You may need to move the student data files for user: [_1] to [_2]',$uname,$match).' '.&mt('Because of this, user [_1] has not been dropped from the course.',$uname).$linefeed; push @saved,$uname; } } elsif (@saved == 0) { +# Check enrollment count for institutional section of student to be dropped + if ($$currlist{$uname}[$instidx]) { + if (exists($classcount{$$currlist{$uname}[$instidx]})) { + if ($classcount{$$currlist{$uname}[$instidx]} == 0) { + if ($autofailsafe) { + push(@{$delaydrops{$$currlist{$uname}[$instidx]}},$uname); + next; + } + } + } + } my $drop_reply = &Apache::lonnet::modifystudent($dom,$uname,'','','',undef,undef,undef,undef,$$currlist{$uname}[$sec],time,undef,undef,undef,undef,'auto','',$cid,'',$context); if ($drop_reply !~ /^ok/) { $$logmsg .= &mt('An error occurred during the attempt to expire the [_1] from the old section [_2] - [_3].',$uname,$$currlist{$uname}[$sec],$drop_reply).$linefeed; @@ -444,11 +475,41 @@ sub update_LC { } } } + if (scalar(keys(%delaydrops)) > 0) { + foreach my $class (keys(%delaydrops)) { + if (ref($delaydrops{$class}) eq 'ARRAY') { + if ($autofailsafe < scalar(@{$delaydrops{$class}})) { + $$logmsg .= &mt('The following students were not expired from the old section [_1] because the enrollment count retrieved for that institutional section was zero, and the number of students with roles to expire exceeded the failsafe threshold of [_2]:',$class,$autofailsafe); + if ($context eq "updatenow") { + $$logmsg .= '
'.join('
',@{$delaydrops{$class}}).$linefeed; + } elsif ($context eq "automated") { + $$logmsg .= $linefeed.join($linefeed,@{$delaydrops{$class}}).$linefeed; + } + } else { + foreach my $uname (@{$delaydrops{$class}}) { + my $drop_reply = &Apache::lonnet::modifystudent($dom,$uname,'','','',undef,undef,undef,undef,$$currlist{$uname}[$sec],time,undef,undef,undef,undef,'auto','',$cid,'',$context); + if ($drop_reply !~ /^ok/) { + $$logmsg .= &mt('An error occurred during the attempt to expire the [_1] from the old section [_2] - [_3].',$uname,$$currlist{$uname}[$sec],$drop_reply).$linefeed; + } else { + $dropcount ++; + my %userenv = &Apache::lonnet::get('environment',['firstname','lastname','id'],$dom,$uname); + $dropresult .= $userenv{'firstname'}." ".$userenv{'lastname'}." (".$userenv{'id'}.") - ".$uname.' '.&mt("dropped from section: '[_1]'.",$$currlist{$uname}[$sec]).$linefeed; + if ($context eq 'automated') { + $$logmsg .= &mt('User [_1] student role expired from course.',$uname).$linefeed; + } + } + } + } + } + } + } } -# Terminated explictly allowed access to student creation/modification +# Terminated explictly allowed access to student creation/modification +# and group membership changes if ($context eq 'automated') { delete($env{'allowed.cst'}); + delete($env{'allowed.mdg'}); } if ($enrollcount > 0) { if ($context eq "updatenow") { @@ -519,6 +580,7 @@ sub create_newuser { my $role = $args->{'role'}; my $inststatus = $args->{'inststatus'}; my $credits = $args->{'credits'}; + my $instsec = $args->{'instsec'}; my $create_passwd = 0; my $authchk = ''; my $outcome; @@ -526,7 +588,7 @@ sub create_newuser { # If no account exists and passwords should be generated if ($auth eq "internal") { if ($authparam eq '') { - $authparam = &create_password(); + $authparam = &create_password($udom); if ($authparam eq '') { $authchk = ''; } else { @@ -563,7 +625,7 @@ sub create_newuser { $outcome = $result; } } else { - $outcome=&Apache::lonnet::modifystudent($udom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,'',undef,$emailaddr,'auto','',$cid,'',$called_context,$inststatus,$credits); + $outcome=&Apache::lonnet::modifystudent($udom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,'',undef,$emailaddr,'auto','',$cid,'',$called_context,$inststatus,$credits,$instsec); } if ($outcome eq 'ok') { my $access = &showaccess($end,$start); @@ -682,7 +744,7 @@ sub prepare_add { sub execute_add { my ($context,$caller,$uname,$dom,$auth,$authparam,$first,$middle,$last, - $gene,$pid,$usec,$end,$start,$emailenc,$credits,$cid,$addresult, + $gene,$pid,$usec,$end,$start,$emailenc,$credits,$instsec,$cid,$addresult, $enrollcount,$linefeed,$logmsg) = @_; # Get the user's information and authentication my %userenv = &Apache::lonnet::get('environment',['firstname','middlename','lastname','generation','id','critnotification','notification','permanentemail','inststatus'],$dom,$uname); @@ -758,7 +820,7 @@ sub execute_add { &Apache::lonnet::modify_student_enrollment($dom,$uname,$pid,$first,$middle, $last,$gene,$usec,$end,$start, 'auto','',$cid,'',$context, - $credits); + $credits,$instsec); if ($classlist_reply eq 'ok') { my $access = &showaccess($end,$start); my $showsec = $usec; @@ -832,6 +894,7 @@ sub parse_classlist { if ("@state" eq "students student") { $uname = $attr->{username}; $$studentsref{$uname}[ $$placeref{'groupID'} ] = $groupID; + $$studentsref{$uname}[ $$placeref{'instsec'} ] = $class; } }, "tagname, attr"], text_h => @@ -889,23 +952,80 @@ sub process_date { } sub create_password { - my $passwd = ''; - my @letts = ("a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z"); - for (my $i=0; $i<8; $i++) { + my ($udom) = @_; + my %passwdconf = &Apache::lonnet::get_passwdconf($udom); + my ($min,$max,@chars); + $min = $Apache::lonnet::passwdmin; + if (ref($passwdconf{'chars'}) eq 'ARRAY') { + if ($passwdconf{'min'} =~ /^\d+$/) { + if ($passwdconf{'min'} > $min) { + $min = $passwdconf{'min'}; + } + } + if ($passwdconf{'max'} =~ /^\d+$/) { + $max = $passwdconf{'max'}; + } + @chars = @{$passwdconf{'chars'}}; + } + my @letts = qw(b c d f g h j k l m n p q r s t v w x y z); + my (@included,%reqd); + if (@chars) { + map { $reqd{$_} = 1; } @chars; + } + if ($reqd{'uc'}) { + my $letter = $letts[int( rand(21) )]; + $letter =~ tr/a-z/A-Z/; + if ($letter ne '') { + push(@included,$letter); + } + } + if ($reqd{'lc'}) { + my $letter = $letts[int( rand(21) )]; + if ($letter ne '') { + push(@included,$letter); + } + } + if ($reqd{'num'}) { + my $number = int( rand(10) ); + if ($number ne '') { + push(@included,$number); + } + } + if ($reqd{'spec'}) { + my @specs = qw(! # * & _ - + $); + my $special = $specs[int( rand(8) )]; + if ($special ne '') { + push(@included,$special); + } + } + my $start = 0; + if (scalar(@included) > 0) { + $start = scalar(@included); + } + my $end = 8; + if ($min =~ /^\d+$/) { + if ($min > $end) { + $end = $min; + } + } + for (my $i=$start; $i<$end; $i++) { my $lettnum = int (rand 2); my $item = ''; if ($lettnum) { - $item = $letts[int( rand(26) )]; + $item = $letts[int( rand(21) )]; my $uppercase = int(rand 2); if ($uppercase) { $item =~ tr/a-z/A-Z/; } } else { $item = int( rand(10) ); - } - $passwd .= $item; + } + if ($item ne '') { + push(@included,$item); + } } - return ($passwd); + my $passwd = join('',&Math::Random::random_permutation(@included)); + return $passwd; } sub get_courseinfo { @@ -944,6 +1064,7 @@ sub place_hash { studentID => 10, credits => 11, inststatus => 12, + instsec => 13, ); return %place; }