--- loncom/enrollment/Enrollment.pm 2003/12/11 03:26:15 1.8 +++ loncom/enrollment/Enrollment.pm 2004/08/23 17:07:27 1.17 @@ -1,5 +1,5 @@ # Automated Enrollment manager -# $Id: Enrollment.pm,v 1.8 2003/12/11 03:26:15 raeburn Exp $ +# $Id: Enrollment.pm,v 1.17 2004/08/23 17:07:27 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -32,7 +32,6 @@ use HTML::Entities; use LONCAPA::Configuration; use Time::Local; use lib '/home/httpd/lib/perl'; -use localenroll; use strict; @@ -48,13 +47,21 @@ sub update_LC { my $sec=&Apache::loncoursedata::CL_SECTION; my $status=&Apache::loncoursedata::CL_STATUS; my $type=&Apache::loncoursedata::CL_TYPE; + my $lockedtype=&Apache::loncoursedata::CL_LOCKEDTYPE; my @localstudents = (); + my @futurestudents = (); + my @activestudents = (); my $currlist; foreach my $uname (keys %{$roster} ) { if ($uname =~ m/^(.+):$dom$/) { if ($$roster{$uname}[$status] eq "Active") { + push @activestudents, $1; + @{$$currlist{$1}} = @{$$roster{$uname}}; push @localstudents, $1; + } elsif ( ($$roster{$uname}[$cstart] > time) && ($$roster{$uname}[$cend] > time || $$roster{$uname}[$cend] == 0 || $$roster{$uname}[$cend] eq '') ) { + push @futurestudents, $1; @{$$currlist{$1}} = @{$$roster{$uname}}; + push @localstudents, $1; } } } @@ -174,6 +181,7 @@ sub update_LC { unless ($uname eq '') { my %uidhash=&Apache::lonnet::idrget($dom,$uname); my @stuinfo = @{$enrollinfo{$uname}}; + my $access = ''; if (grep/^$uname$/,@localstudents) { # Check for studentID changes if ( ($uidhash{$uname}) && ($uidhash{$uname} !~ /error\:/) ) { @@ -181,15 +189,63 @@ sub update_LC { $$logmsg .= "Change in ID for $uname. StudentID in LON-CAPA system is $uidhash{$uname}; StudentID in institutional data is $stuinfo[ $place{studentID} ]".$linefeed; } } - +# Check for switch from manual to auto + unless (($$currlist{$uname}[$type] eq "auto") || ($$currlist{$uname}[$lockedtype] eq "1") || (!$adds) ) { +# drop manually added student + my $drop_reply = &Apache::lonnet::modifystudent($dom,$uname,'','','',undef,undef,undef,undef,$$currlist{$uname}[$sec],time,undef,undef,undef,undef,'auto','',$cid); +# re-enroll as auto student + if ($drop_reply !~ /^ok/) { + $$logmsg .= "An error occured during the attempt to convert $uname from a manual type to an auto type student - $drop_reply.".$linefeed; + } else { +# re-enroll as auto student + my ($auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,$emailaddr,$pid,$emailenc); + &prepare_add($authtype,$autharg,$enddate,$startdate,\@stuinfo,\%place,\$dom,\$uname,\$auth,\$authparam,\$first,\$middle,\$last,\$gene,\$usec,\$end,\$start,\$emailaddr,\$pid,\$emailenc); + if ($$currlist{$uname}[$sec] ne $usec) { + $$logmsg .= "Section for $uname switched from $$currlist{$uname}[$sec] to $usec".$linefeed; + } + &execute_add($context,'switchtype',$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$cid,\$addresult,\$enrollcount,$linefeed,$logmsg); + } + } # Check for section changes - unless ($$currlist{$uname}[$sec] eq $stuinfo[ $place{groupID} ]) { + if ($$currlist{$uname}[$sec] eq $stuinfo[ $place{groupID} ]) { +# Check for access date changes for students with access starting in the future. + 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); + $access = &showaccess($enddate,$startdate); + if ($modify_access_result =~ /^ok/) { + $$logmsg .= "Change in access dates for $uname.".$access.$linefeed; + } else { + $$logmsg .= "Error when attempting to change start and/or end access dates for $uname in section: ".$stuinfo[ $place{groupID} ]." -error $modify_access_result".$linefeed; + } + } + } + } else { if ( ($$currlist{$uname}[$type] eq "auto") && ($adds == 1) ) { - my $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); - if ($modify_section_result =~ /^ok/) { - $$logmsg .= "Section for $uname switched from old section: ".$$currlist{$uname}[$sec] ." to new section: ".$stuinfo[ $place{groupID} ].".".$linefeed; +# Delete from roles.db for current section + my $expiretime = time; + my $uurl='/'.$cid; + $uurl=~s/\_/\//g; + if ($$currlist{$uname}[$sec]) { + $uurl.='/'.$$currlist{$uname}[$sec]; + } + my $expire_role_result = &Apache::lonnet::assignrole($dom,$uname,$uurl,'st',$expiretime); + 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); + } else { + $modify_section_result = &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid); + $access = &showaccess($enddate,$startdate); + } + if ($modify_section_result =~ /^ok/) { + $$logmsg .= "Section for $uname switched from old section: ".$$currlist{$uname}[$sec] ." to new section: ".$stuinfo[ $place{groupID} ].".".$access.$linefeed; + } else { + $$logmsg .= "Error when attempting section change for $uname from old section ".$$currlist{$uname}[$sec]." to new section: ".$stuinfo[ $place{groupID} ]." -error: $modify_section_result".$linefeed; + } } else { - $$logmsg .= "Error when attempting section change for $uname from old section ".$$currlist{$uname}[$sec]." to new section: ".$stuinfo[ $place{groupID} ]." -error: $modify_section_result".$linefeed; + $$logmsg .= "Error when attempting to expire role for $uname in old section" .$$currlist{$uname}[$sec]." -error: $expire_role_result".$linefeed; } } } @@ -204,46 +260,8 @@ sub update_LC { } } } elsif ($adds == 1) { -# Add student to LON-CAPA classlist - my $auth = $stuinfo[ $place{'authtype'} ]; - my $authparam = $stuinfo[ $place{'autharg'} ]; - my $first = $stuinfo[ $place{'firstname'} ]; - my $middle = $stuinfo[ $place{'middlename'} ]; - my $last = $stuinfo[ $place{'lastname'} ]; - my $gene = $stuinfo[ $place{'generation'} ]; - my $usec = $stuinfo[ $place{'groupID'} ]; - my $end = $stuinfo[ $place{'enddate'} ]; - my $start = $stuinfo[ $place{'startdate'} ]; - my $emailaddr = $stuinfo[ $place{'email'} ]; - my $pid = $stuinfo[ $place{'studentID'} ]; - -# remove non alphanumeric values from section - $usec =~ s/\W//g; - - unless ($emailaddr =~/^[^\@]+\@[^\@]+$/) { $emailaddr =''; } - my $emailenc = &HTML::Entities::encode($emailaddr); - -# Use course defaults where entry is absent - if ( ($auth eq '') || (!defined($auth)) ) { - $auth = $authtype; - } - if ( ($authparam eq '') || (!defined($authparam)) ) { - $authparam = $autharg; - } - if ($auth =~ m/^krb/) { - $auth .= ":".$authparam; - } - if ( ($end eq '') || (!defined($end)) ) { - $end = $enddate; - } - if ( ($start eq '') || (!defined($start)) ) { - $start = $startdate; - } -# Clean up whitespace - foreach (\$dom,\$uname,\$pid,\$first,\$middle,\$last,\$gene,\$usec) { - $$_ =~ s/(\s+$|^\s+)//g; - } - + my ($auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,$emailaddr,$pid,$emailenc); + &prepare_add($authtype,$autharg,$enddate,$startdate,\@stuinfo,\%place,\$dom,\$uname,\$auth,\$authparam,\$first,\$middle,\$last,\$gene,\$usec,\$end,\$start,\$emailaddr,\$pid,\$emailenc); # Check for existing account in this LON-CAPA domain for this username my $uhome=&Apache::lonnet::homeserver($uname,$dom); if ($uhome eq 'no_host') { # User does not exist @@ -251,18 +269,19 @@ sub update_LC { my $authchk = ''; unless ($authparam eq '') { $authchk = 'ok'; }; # If no account exists and passwords should be generated - if ($authtype eq "int") { + if ($auth eq "internal") { if ($authparam eq '') { ($authparam) = &create_password(); if ($authparam eq '') { - $authchk = ''; + $authchk = ''; } else { $create_passwd = 1; + $authchk = 'ok'; } } - } elsif ($authtype eq "local") { - ($authparam,$create_passwd,$authchk) = &localenroll::create_password($authparam); - } elsif ($authtype =~ m/^krb/) { + } elsif ($auth eq "localauth") { + ($authparam,$create_passwd,$authchk) = &Apache::lonnet::auto_create_password($crs,$dom,$authparam); + } elsif ($auth =~ m/^krb/) { if ($authparam eq '') { $$logmsg .= "No Kerberos domain was provided for the new user - $uname, so the new student was not enrolled in the course.".$linefeed; $authchk = 'invalid'; @@ -273,10 +292,11 @@ sub update_LC { } if ($authchk eq 'ok') { # Now create user. - my $reply=&Apache::lonnet::modifystudent($dom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,'',undef,$emailaddr,'auto',$cid); + my $reply=&Apache::lonnet::modifystudent($dom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,'',undef,$emailaddr,'auto','',$cid); if ($reply eq 'ok') { + $access = &showaccess($end,$start); $enrollcount ++; - $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed; + $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$access.$linefeed; if ($context eq 'automated') { $$logmsg .= "New $dom user $uname added successfully."; } @@ -310,73 +330,7 @@ sub update_LC { } } } else { -# Get the user's information and authentication - my %userenv = &Apache::lonnet::get('environment',['firstname','middlename','lastname','generation','id','critnotification','notification'],$dom,$uname); - my ($tmp) = keys(%userenv); - if ($tmp =~ /^(con_lost|error)/i) { - %userenv = (); - } -# Get the user's e-mail address - if ($userenv{critnotification} =~ m/%40/) { - unless ($emailenc eq $userenv{critnotification}) { - $$logmsg .= "Current critical notification e-mail - ".$userenv{critnotification}." for $uname is different to e-mail address in Institutional classlist - ".$emailenc.$linefeed; - } - } - if ($userenv{notification} =~ m/%40/) { - unless ($emailenc eq $userenv{critnotification}) { - $$logmsg .= "Current standard notification e-mail - ".$userenv{notification}." for $uname is different to e-mail address in institutional classlist - ".$emailenc.$linefeed; - } - } - my $krbdefdom = ''; - my $currentauth=&Apache::lonnet::queryauthenticate($uname,$dom); - if ($currentauth=~/^krb(4|5):/) { - $currentauth=~/^krb(4|5):(.*)/; - $krbdefdom=$1; - } - if ($currentauth=~/^krb(4|5):/ || - $currentauth=~/^unix:/ || - $currentauth=~/^internal:/ || - $currentauth=~/^localauth:/) { - - } else { - $$logmsg .= "Invalid authentication method $currentauth for $uname.".$linefeed; - } -# Report if authentication methods are different. - if ($currentauth ne $auth ) { - $$logmsg .= "Authentication mismatch for $uname - $currentauth in system, $auth based on information in classlist or default for this course.".$linefeed; - } -# Check user data - if ($first ne $userenv{'firstname'} || - $middle ne $userenv{'middlename'} || - $last ne $userenv{'lastname'} || - $gene ne $userenv{'generation'} || - $pid ne $userenv{'id'} ) { -# Make the change(s) - my %changeHash; - $changeHash{'firstname'} = $first; - $changeHash{'middlename'} = $middle; - $changeHash{'lastname'} = $last; - $changeHash{'generation'} = $gene; - $changeHash{'id'} = $pid; - my $putresult = &Apache::lonnet::put('environment',\%changeHash,$dom,$uname); - if ($putresult eq 'ok') { - $$logmsg .= "User information updated for user: $uname prior to enrollment.".$linefeed; - } else { - $$logmsg .= "There was a problem modifying user data for existing user - $uname -error: $putresult, enrollment will still be attempted.".$linefeed; - } - } - -# Assign the role of student in the course. - my $classlist_reply = &Apache::lonnet::modify_student_enrollment($dom,$uname,$pid,$first,$middle,$last,$gene,$usec,$end,$start,'auto',$cid); - if ($classlist_reply eq 'ok') { - $enrollcount ++; - $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed; - if ($context eq 'automated') { - $$logmsg .= "Existing $dom user $uname enrolled successfully.".$linefeed; - } - } else { - $$logmsg .= "There was a problem updating the classlist db file for user $uname to show the new enrollment -error: $classlist_reply, so no enrollment occurred for this user.".$linefeed; - } + &execute_add($context,'newstudent',$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$cid,\$addresult,\$enrollcount,$linefeed,$logmsg); } } } @@ -395,7 +349,7 @@ sub update_LC { push @saved,$uname; } } elsif (@saved == 0) { - my $drop_reply = &Apache::lonnet::modifystudent($dom,$uname,'','','',undef,undef,undef,undef,$$currlist{$uname}[$sec],time,undef,undef,undef,undef,undef,$cid); + my $drop_reply = &Apache::lonnet::modifystudent($dom,$uname,'','','',undef,undef,undef,undef,$$currlist{$uname}[$sec],time,undef,undef,undef,undef,'auto','',$cid); if ($drop_reply !~ /^ok/) { $$logmsg .= "An error occured during the attempt to expire the $uname from the old section $$currlist{$uname}[$sec] - $drop_reply.".$linefeed; } else { @@ -452,6 +406,162 @@ sub update_LC { return ($changecount,$addresult.$dropresult); } +sub prepare_add { + my ($authtype,$autharg,$enddate,$startdate,$stuinfo,$place,$dom,$uname,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,$emailaddr,$pid,$emailenc) = @_; + $$auth = $$stuinfo[ $$place{'authtype'} ]; + $$authparam = $$stuinfo[ $$place{'autharg'} ]; + $$first = $$stuinfo[ $$place{'firstname'} ]; + $$middle = $$stuinfo[ $$place{'middlename'} ]; + $$last = $$stuinfo[ $$place{'lastname'} ]; + $$gene = $$stuinfo[ $$place{'generation'} ]; + $$usec = $$stuinfo[ $$place{'groupID'} ]; + $$end = $$stuinfo[ $$place{'enddate'} ]; + $$start = $$stuinfo[ $$place{'startdate'} ]; + $$emailaddr = $$stuinfo[ $$place{'email'} ]; + $$pid = $$stuinfo[ $$place{'studentID'} ]; + +# remove non alphanumeric values from section + $$usec =~ s/\W//g; + + unless ($$emailaddr =~/^[^\@]+\@[^\@]+$/) { $$emailaddr =''; } + $$emailenc = &HTML::Entities::encode($$emailaddr,'<>&"'); + +# Use course defaults where entry is absent + if ( ($$auth eq '') || (!defined($$auth)) ) { + $$auth = $authtype; + } + if ( ($$authparam eq '') || (!defined($$authparam)) ) { + $$authparam = $autharg; + } + if ( ($$end eq '') || (!defined($$end)) ) { + $$end = $enddate; + } + if ( ($$start eq '') || (!defined($$start)) ) { + $$start = $startdate; + } +# Clean up whitespace + foreach ($dom,$uname,$pid,$first,$middle,$last,$gene,$usec) { + $$_ =~ s/(\s+$|^\s+)//g; + } + return; +} + +sub execute_add { + my ($context,$caller,$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$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'],$dom,$uname); + my ($tmp) = keys(%userenv); + if ($tmp =~ /^(con_lost|error)/i) { + %userenv = (); + } +# Get the user's e-mail address + if ($userenv{critnotification} =~ m/%40/) { + unless ($emailenc eq $userenv{critnotification}) { + $$logmsg .= "Current critical notification e-mail +- ".$userenv{critnotification}." for $uname is different to e-mail address in institutional classlist - ".$emailenc.$linefeed; + } + } + if ($userenv{notification} =~ m/%40/) { + unless ($emailenc eq $userenv{critnotification}) { + $$logmsg .= "Current standard notification e-mail +- ".$userenv{notification}." for $uname is different to e-mail address in institutional classlist - ".$emailenc.$linefeed; + } + } + my $krbdefdom = ''; + my $currentauth=&Apache::lonnet::queryauthenticate($uname,$dom); + if ($currentauth=~/^(krb[45]):(.*)/) { + $currentauth = $1; + $krbdefdom = $2; + } elsif ($currentauth=~ /^(unix|internal|localauth):/) { + $currentauth = $1; + } else { + $$logmsg .= "Invalid authentication method $currentauth for $uname.".$linefeed; + } +# Report if authentication methods are different. + if ($currentauth ne $auth) { + $$logmsg .= "Authentication type mismatch for $uname - '$currentauth' in system, '$auth' based on information in classlist or default for this course.".$linefeed; + } elsif ($auth =~ m/^krb/) { + if ($krbdefdom ne $authparam) { + $$logmsg .= "Kerberos domain mismatch for $uname - '$krbdefdom' in system, '$authparam' based on information in classlist or default for this course.".$linefeed; + } + } + +# Check user data + if ($first ne $userenv{'firstname'} || + $middle ne $userenv{'middlename'} || + $last ne $userenv{'lastname'} || + $gene ne $userenv{'generation'} || + $pid ne $userenv{'id'} ) { +# Make the change(s) + my %changeHash; + $changeHash{'firstname'} = $first; + $changeHash{'middlename'} = $middle; + $changeHash{'lastname'} = $last; + $changeHash{'generation'} = $gene; + $changeHash{'id'} = $pid; + my $putresult = &Apache::lonnet::put('environment',\%changeHash,$dom,$uname); + if ($putresult eq 'ok') { + $$logmsg .= "User information updated for user: $uname prior to enrollment.".$linefeed; + } else { + $$logmsg .= "There was a problem modifying user data for existing user - $uname -error: $putresult, enrollment will still be attempted.".$linefeed; + } + } + +# Assign the role of student in the course. + my $classlist_reply = &Apache::lonnet::modify_student_enrollment($dom,$uname,$pid,$first,$middle,$last,$gene,$usec,$end,$start,'auto','',$cid); + if ($classlist_reply eq 'ok') { + my $access = &showaccess($end,$start); + if ($caller eq 'switchtype') { + $$logmsg .= "Existing user $uname detected in institutional classlist - switched from 'manual' to 'auto' enrollment in section/group $usec.".$access.$linefeed; + } elsif ($caller eq 'newstudent') { + $$enrollcount ++; + $$addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$access.$linefeed; + } + if ($context eq 'automated') { + $$logmsg .= "Existing $dom user $uname enrolled successfully.".$linefeed; + } + } else { + $$logmsg .= "There was a problem updating the classlist db file for user $uname to show the new enrollment -error: $classlist_reply, so no enrollment occurred for this user.".$linefeed; + } + return; +} + +sub datechange_check { + my ($oldstart,$oldend,$startdate,$enddate) = @_; + my $datechange = 0; + unless ($oldstart eq $startdate) { + $datechange = 1; + } + if (!$datechange) { + if (!$oldend) { + if ($enddate) { + $datechange = 1; + } + } elsif ($oldend ne $enddate) { + $datechange = 1; + } + } + return $datechange; +} + +sub showaccess { + my ($end,$start) = @_; + my $showstart; + my $showend; + if ( (!$start) || ($start <= time) ) { + $showstart = 'immediately'; + } else { + $showstart = &Apache::lonlocal::locallocaltime($start); + } + if (!$end) { + $showend = 'no end date'; + } else { + $showend = &Apache::lonlocal::locallocaltime($end); + } + my $access_msg = " Access starts: ".$showstart.", ends: ".$showend."."; + return $access_msg; +} + sub parse_classlist { my ($tmpdir,$dom,$crs,$class,$placeref,$groupID,$studentsref) = @_; my $xmlfile = $tmpdir."/tmp/".$dom."_".$crs."_".$class."_classlist.xml"; @@ -527,7 +637,7 @@ 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"; + 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 $lettnum = int (rand 2); my $item = ''; @@ -545,6 +655,44 @@ sub create_password { return ($passwd); } +sub check_user_status { + my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_; + my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname); + my @uroles = keys %userinfo; + my $srchstr; + my $active_chk = 'none'; + if (@uroles > 0) { + if ( ($role eq 'cc') || ($secgrp eq '') || ( !defined($secgrp) ) ) { + $srchstr = '/'.$cdom.'/'.$crs.'_'.$role; + } else { + $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role; + } + if (grep/^$srchstr$/,@uroles) { + my $role_end = 0; + my $role_start = 0; + $active_chk = 'ok'; + if ( $userinfo{$srchstr} =~ m/^($role)_(\d+)/ ) { + $role_end = $2; + if ( $userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/ ) + { + $role_start = $3; + } + } + if ($role_start > 0) { + if (time < $role_start) { + $active_chk = 'expired'; + } + } + if ($role_end > 0) { + if (time > $role_end) { + $active_chk = 'expired'; + } + } + } + } + return $active_chk; +} + sub CL_autharg { return 0; } sub CL_authtype { return 1;} sub CL_email { return 2;}