--- loncom/enrollment/Enrollment.pm 2003/12/09 00:31:51 1.6 +++ loncom/enrollment/Enrollment.pm 2004/03/18 16:46:28 1.12 @@ -1,14 +1,43 @@ +# Automated Enrollment manager +# $Id: Enrollment.pm,v 1.12 2004/03/18 16:46:28 raeburn Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# package LONCAPA::Enrollment; use Apache::loncoursedata; use Apache::lonnet; +use Apache::lonmsg; use HTML::Entities; use LONCAPA::Configuration; +use Time::Local; +use lib '/home/httpd/lib/perl'; +use localenroll; use strict; sub update_LC { - my ($dom,$crs,$adds,$drops,$startdate,$enddate,$authtype,$autharg,$classesref,$groupref,$logmsg,$context) = @_; + my ($dom,$crs,$adds,$drops,$startdate,$enddate,$authtype,$autharg,$classesref,$groupref,$logmsg,$newusermsg,$context) = @_; # Get current LON-CAPA student enrollment for this class my $configvars = &LONCAPA::Configuration::read_conf('loncapa.conf'); my $cid = $dom."_".$crs; @@ -40,6 +69,8 @@ sub update_LC { my $enrollcount = 0; my $dropcount = 0; + srand( time() ^ ($$ + ($$ << 15)) ); # Seed rand in case initial passwords have to be generated for new users. + # Get mapping of IDs to usernames for current LON-CAPA student enrollment for this class my @LCids = (); my %unameFromLCid = (); @@ -154,11 +185,23 @@ sub update_LC { # Check for section changes unless ($$currlist{$uname}[$sec] eq $stuinfo[ $place{groupID} ]) { 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 = &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; + } 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; } } } @@ -199,9 +242,6 @@ sub update_LC { if ( ($authparam eq '') || (!defined($authparam)) ) { $authparam = $autharg; } - if ($auth =~ m/^krb/) { - $auth .= ":".$authparam; - } if ( ($end eq '') || (!defined($end)) ) { $end = $enddate; } @@ -220,15 +260,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_passwd,$authchk) = &create_password(); - } - } elsif ($authtype eq "local") { - if ($authparam eq '') { - ($authparam,$create_passwd,$authchk) = &create_password(); + ($authparam) = &create_password(); + if ($authparam eq '') { + $authchk = ''; + } else { + $create_passwd = 1; + $authchk = 'ok'; + } } - } elsif ($authtype =~ m/^krb/) { + } elsif ($auth eq "localauth") { + ($authparam,$create_passwd,$authchk) = &localenroll::create_password($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'; @@ -244,7 +288,7 @@ sub update_LC { $enrollcount ++; $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed; if ($context eq 'automated') { - $$logmsg .= "New $dom user $uname added successfully.".$linefeed; + $$logmsg .= "New $dom user $uname added successfully."; } unless ($emailenc eq '') { my %emailHash; @@ -253,10 +297,23 @@ sub update_LC { my $putresult = &Apache::lonnet::put('environment',\%emailHash,$dom,$uname); } if ($create_passwd) { -# Send e-mail with inital password to new user at $emailaddr - $$logmsg .= "Initial password - - sent to ".$emailaddr.$linefeed; +# Send e-mail with initial password to new user at $emailaddr. +# If e-mail address is invalid, send password via message to courseowner i +# (if automated call) or to user if roster update. + if ($emailaddr eq '') { + $$newusermsg .= " username: $uname, password: ".$authparam.$linefeed."\n"; + } else { + my $subject = "New LON-CAPA account"; + my $body = "You have been enrolled in the LON-CAPA system at your school, because you are a registered student in a class that is using the LON-CAPA course management and online homework system.\n\nYou should log-in to the system using the following credentials:\nusername: $uname\npassword: $authparam\n\nThe URL you should use to access the LON-CAPA system at your school is: http://".$ENV{'SERVER_NAME'}; + &Apache::lonmsg::sendemail($emailaddr,$subject,$body); + } + if ($context eq 'automated') { + $$logmsg .= " Initial password - - sent to ".$emailaddr.$linefeed; + } } else { - $$logmsg .= $linefeed; + if ($context eq 'automated') { + $$logmsg .= $linefeed; + } } } else { $$logmsg .= "An error occurred adding new user $uname - ".$reply.$linefeed; @@ -282,22 +339,22 @@ sub update_LC { } 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:/) { - + 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 mismatch for $uname - $currentauth in system, $auth based on information in classlist or default for this course.".$linefeed; - } + 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'} || @@ -355,6 +412,9 @@ sub update_LC { $dropcount ++; my %userenv = &Apache::lonnet::get('environment',['firstname','lastname','id'],$dom,$uname); $dropresult .= $userenv{'firstname'}." ".$userenv{'lastname'}." (".$userenv{'id'}.") - ".$uname." dropped from section/group ".$$currlist{$uname}[$sec].$linefeed; + if ($context eq 'automated') { + $$logmsg .= "User $uname student role expired from course.".$linefeed; + } } } } @@ -407,7 +467,7 @@ sub parse_classlist { my $xmlfile = $tmpdir."/tmp/".$dom."_".$crs."_".$class."_classlist.xml"; my $uname = ''; my @state; - my @items = ('autharg','authtype','email','enddate','firstname','generation','lastname','middlename','startdate','studentID'); + my @items = ('autharg','authtype','email','firstname','generation','lastname','middlename','studentID'); my $p = HTML::Parser->new ( xml_mode => 1, @@ -424,6 +484,18 @@ sub parse_classlist { my ($text) = @_; if ("@state" eq "students student groupID") { $$studentsref{$uname}[ $$placeref{'groupID'} ] = $groupID; + } elsif ("@state" eq "students student startdate") { + my $start = $text; + unless ($text eq '') { + $start = &process_date($text); + } + $$studentsref{$uname}[ $$placeref{'startdate'} ] = $start; + } elsif ("@state" eq "students student enddate") { + my $end = $text; + unless ($text eq '') { + $end = &process_date($text); + } + $$studentsref{$uname}[ $$placeref{'enddate'} ] = $end; } else { foreach my $item (@items) { if ("@state" eq "students student $item") { @@ -441,15 +513,84 @@ sub parse_classlist { $p->parse_file($xmlfile); $p->eof; -# if (-e "$xmlfile") { -# unlink $xmlfile; -# } + if (-e "$xmlfile") { + unlink $xmlfile; + } return; } +sub process_date { + my $timestr = shift; + my $timestamp = ''; + if ($timestr =~ m/^\d{4}:\d{2}:\d{2}/) { + my @entries = split/:/,$timestr; + for (my $j=0; $j<@entries; $j++) { + if ( length($entries[$j]) > 1 ) { + $entries[$j] =~ s/^0//; + } + } + $entries[1] = $entries[1] - 1; + $timestamp = timelocal($entries[5],$entries[4],$entries[3],$entries[2],$entries[1],$entries[0]); + } + return $timestamp; +} + sub create_password { - my ($authparam,$create_passwd,$authreply); - return ($authparam,$create_passwd,$authreply); + 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 $lettnum = int (rand 2); + my $item = ''; + if ($lettnum) { + $item = $letts[int( rand(26) )]; + my $uppercase = int(rand 2); + if ($uppercase) { + $item =~ tr/a-z/A-Z/; + } + } else { + $item = int( rand(10) ); + } + $passwd .= $item; + } + 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; }