--- loncom/enrollment/Enrollment.pm	2004/06/17 18:31:24	1.15
+++ loncom/enrollment/Enrollment.pm	2004/06/29 04:30:00	1.16
@@ -1,5 +1,5 @@
 # Automated Enrollment manager
-# $Id: Enrollment.pm,v 1.15 2004/06/17 18:31:24 raeburn Exp $
+# $Id: Enrollment.pm,v 1.16 2004/06/29 04:30:00 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -48,6 +48,7 @@ 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 = ();
@@ -189,25 +190,30 @@ 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
                 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 = 0;
-                        unless ($$currlist{$uname}[$cstart] eq $startdate) {
-                            $datechange = 1;
-                        }
-                        if (!$datechange) {
-                            if (!$$currlist{$uname}[$cend]) {
-                                if ($enddate) {
-                                    $datechange = 1;
-                                }
-                            } elsif ($$currlist{$uname}[$cend] ne $enddate) {
-                                $datechange = 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);
+                            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;
@@ -229,9 +235,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);
+                                $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);
+                                $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/) {
@@ -255,43 +261,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 ( ($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
@@ -322,7 +293,7 @@ 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 ++;
@@ -360,75 +331,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[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') {
-                            $access = &showaccess($end,$start);
-                            $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;
-                        }
+                        &execute_add($context,'newstudent',$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$cid,\$addresult,\$enrollcount,$linefeed,$logmsg);
                     }
                 }
             }
@@ -447,7 +350,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,'auto',$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 {
@@ -504,6 +407,144 @@ 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;