[BACK]Return to Enrollment.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / enrollment

Diff for /loncom/enrollment/Enrollment.pm between versions 1.5 and 1.9

version 1.5, 2003/12/08 15:51:40 version 1.9, 2003/12/15 05:39:40
Line 1 Line 1
   # Automated Enrollment manager
   # $Id$
   #
   # 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;  package LONCAPA::Enrollment;
   
 use Apache::loncoursedata;  use Apache::loncoursedata;
 use Apache::lonnet;  use Apache::lonnet;
   use Apache::lonmsg;
 use HTML::Entities;  use HTML::Entities;
 use XML::Simple;  
 use LONCAPA::Configuration;  use LONCAPA::Configuration;
   use Time::Local;
   use lib '/home/httpd/lib/perl';
   use localenroll;
   
 use strict;  use strict;
   
 sub update_LC {  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  # Get current LON-CAPA student enrollment for this class
     my $configvars = &LONCAPA::Configuration::read_conf('loncapa.conf');      my $configvars = &LONCAPA::Configuration::read_conf('loncapa.conf');
     my $cid = $dom."_".$crs;      my $cid = $dom."_".$crs;
Line 41  sub update_LC { Line 69  sub update_LC {
     my $enrollcount = 0;      my $enrollcount = 0;
     my $dropcount = 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   # Get mapping of IDs to usernames for current LON-CAPA student enrollment for this class 
     my @LCids = ();      my @LCids = ();
     my %unameFromLCid = ();      my %unameFromLCid = ();
Line 114  sub update_LC { Line 144  sub update_LC {
                     $$logmsg .= " $_,";                      $$logmsg .= " $_,";
                 }                  }
                 chop($$logmsg);                  chop($$logmsg);
                 $$logmsg .= " Because of this ambiguity, no enrollment action was taken for this student.".$linefeed;                  $$logmsg .= ". Because of this ambiguity, no enrollment action was taken for this student.".$linefeed;
             }              }
         } else {          } else {
             @{$enrollinfo{$uname}} = @{$allenrolled{$uname}[0]};              @{$enrollinfo{$uname}} = @{$allenrolled{$uname}[0]};
Line 148  sub update_LC { Line 178  sub update_LC {
 # Check for studentID changes  # Check for studentID changes
                 if ( ($uidhash{$uname}) && ($uidhash{$uname} !~ /error\:/) )  {                  if ( ($uidhash{$uname}) && ($uidhash{$uname} !~ /error\:/) )  {
                     unless ( ($uidhash{$uname}) eq ($stuinfo[ $place{studentID} ]) ) {                      unless ( ($uidhash{$uname}) eq ($stuinfo[ $place{studentID} ]) ) {
                         $$logmsg .= "Change in ID for $uname in class: $crs. StudentID in LON-CAPA system is $uidhash{$uname}, StudentID in institutional data is $stuinfo[ $place{studentID} ]".$linefeed;                           $$logmsg .= "Change in ID for $uname. StudentID in LON-CAPA system is $uidhash{$uname}; StudentID in institutional data is $stuinfo[ $place{studentID} ]".$linefeed; 
                     }                      }
                 }                  }
   
Line 157  sub update_LC { Line 187  sub update_LC {
                     if ( ($$currlist{$uname}[$type] eq "auto") && ($adds == 1) ) {                      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);                          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/) {                          if ($modify_section_result =~ /^ok/) {
                             $$logmsg .= "Section for $uname switched from old section: ".$$currlist{$uname}[$sec] ."to new section: ".$stuinfo[ $place{groupID} ]." in class $crs".$linefeed;                              $$logmsg .= "Section for $uname switched from old section: ".$$currlist{$uname}[$sec] ." to new section: ".$stuinfo[ $place{groupID} ].".".$linefeed;
                         } else {                          } 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 section change for $uname from old section ".$$currlist{$uname}[$sec]." to new section: ".$stuinfo[ $place{groupID} ]." -error: $modify_section_result".$linefeed;
                         }                          }
Line 169  sub update_LC { Line 199  sub update_LC {
                     if (grep/^$$currlist{$uname}[ $place{'studentID'} ]$/,@allINids) {                      if (grep/^$$currlist{$uname}[ $place{'studentID'} ]$/,@allINids) {
                         foreach my $match ( @{ $unameFromLCid{ $stuinfo[ $place{studentID} ] } }  ) {                          foreach my $match ( @{ $unameFromLCid{ $stuinfo[ $place{studentID} ] } }  ) {
                             if (grep/^$match$/,@okusers) {                              if (grep/^$match$/,@okusers) {
                                 $$logmsg .= "A possible change in username has been detected for a student enrolled in $crs. The existing LON-CAPA classlist contains user: $uname and student ID: ".$$currlist{$uname}[ $place{studentID} ].".  This username has been dropped from the institutional classlist, but the same student ID is used for user: $match who still appears in the institutional classlist. You may need to move the student data files for user: $uname to $match".$linefeed;                                  $$logmsg .= "A possible change in username has been detected for a student enrolled in this course. The existing LON-CAPA classlist contains user: $uname and student ID: ".$$currlist{$uname}[ $place{studentID} ].".  This username has been dropped from the institutional classlist, but the same student ID is used for user: $match who still appears in the institutional classlist. You may need to contact your Domain Coordinator to request a move of the student data files for user: $uname to $match".$linefeed;
                             }                              }
                         }                          }
                     }                      }
Line 223  sub update_LC { Line 253  sub update_LC {
 # If no account exists and passwords should be generated  # If no account exists and passwords should be generated
                         if ($authtype eq "int") {                          if ($authtype eq "int") {
                             if ($authparam eq '') {                              if ($authparam eq '') {
                                 ($authparam,$create_passwd,$authchk) = &create_password();                                  ($authparam) = &create_password();
                                   if ($authparam eq '') {
                                        $authchk = '';
                                   } else {
                                       $create_passwd = 1;
                                   }        
                             }                              }
                         } elsif ($authtype eq "local") {                          } elsif ($authtype eq "local") {
                             if ($authparam eq '') {                               ($authparam,$create_passwd,$authchk) = &localenroll::create_password($authparam);
                                 ($authparam,$create_passwd,$authchk) = &create_password();  
                             }  
                         } elsif ($authtype =~ m/^krb/) {                          } elsif ($authtype =~ m/^krb/) {
                             if ($authparam eq '') {                              if ($authparam eq '') {
                                 $$logmsg .= "No Kerberos domain available for the new user - $uname in course $crs - no enrollment occurred.".$linefeed;                                  $$logmsg .= "No Kerberos domain was provided for the new user - $uname, so the new student was not enrolled in the course.".$linefeed;
                                 $authchk = 'invalid';                                  $authchk = 'invalid';
                             }                              }
                         } else {                          } else {
                             $authchk = 'invalid';                              $authchk = 'invalid';
                             $$logmsg .= "Invalid authentication type for new user - $uname in course $crs - no enrollment occurred.".$linefeed;                              $$logmsg .= "An invalid authentication type was provided for the new user - $uname, so the student was not enrolled in the course.".$linefeed;
                         }                          }
                         if ($authchk eq 'ok') {                           if ($authchk eq 'ok') { 
 # Now create user.  # Now create user.
Line 244  sub update_LC { Line 277  sub update_LC {
                             if ($reply eq 'ok') {                              if ($reply eq 'ok') {
                                 $enrollcount ++;                                  $enrollcount ++;
                                 $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed;                                  $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed;
                                 $$logmsg .= "New user $uname added successfully. ";                                  if ($context eq 'automated') {
                                       $$logmsg .= "New $dom user $uname added successfully.";
                                   }
                                 unless ($emailenc eq '') {                                  unless ($emailenc eq '') {
                                     my %emailHash;                                      my %emailHash;
                                     $emailHash{'critnotification'}  = $emailenc;                                      $emailHash{'critnotification'}  = $emailenc;
Line 252  sub update_LC { Line 287  sub update_LC {
                                     my $putresult = &Apache::lonnet::put('environment',\%emailHash,$dom,$uname);                                      my $putresult = &Apache::lonnet::put('environment',\%emailHash,$dom,$uname);
                                 }                                  }
                                 if ($create_passwd) {                                  if ($create_passwd) {
 # Send e-mail with inital password to new user at $emailaddr  # Send e-mail with initial password to new user at $emailaddr. 
                                     $$logmsg .= "Initial password -  - sent to ".$emailaddr.$linefeed;  # 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 {                                  } else {
                                     $$logmsg .= $linefeed;                                      if ($context eq 'automated') {
                                           $$logmsg .= $linefeed;
                                       }
                                 }                                  }
                             } else {                              } else {
                                 $$logmsg .= "An error occurred adding new user $uname - ".$reply.$linefeed;                                  $$logmsg .= "An error occurred adding new user $uname - ".$reply.$linefeed;
Line 295  sub update_LC { Line 343  sub update_LC {
                         }                          }
 # Report if authentication methods are different.  # Report if authentication methods are different.
                         if ($currentauth ne $auth ) {                          if ($currentauth ne $auth ) {
                             $$logmsg .= "Authentication mismatch for $uname - $currentauth in system, $auth for class $crs".$linefeed;                              $$logmsg .= "Authentication mismatch for $uname - $currentauth in system, $auth based on information in classlist or default for this course.".$linefeed;
                         }                          }
 # Check user data  # Check user data
                         if ($first  ne $userenv{'firstname'}  ||                          if ($first  ne $userenv{'firstname'}  ||
Line 323  sub update_LC { Line 371  sub update_LC {
                         if ($classlist_reply eq 'ok') {                          if ($classlist_reply eq 'ok') {
                             $enrollcount ++;                              $enrollcount ++;
                             $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed;                              $addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$linefeed;
                             $$logmsg .= "Existing user $uname enrolled successfully.".$linefeed;                              if ($context eq 'automated') {
                                   $$logmsg .= "Existing $dom user $uname enrolled successfully.".$linefeed;
                               }
                         } else {                          } 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;                              $$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;
                         }                          }
Line 342  sub update_LC { Line 391  sub update_LC {
 # Check for changed usernames by checking studentIDs  # Check for changed usernames by checking studentIDs
                     if (grep/^$$currlist{$uname}[ $stuid ]$/,@allINids) {                      if (grep/^$$currlist{$uname}[ $stuid ]$/,@allINids) {
                         foreach my $match (@{$unameFromINid{$$currlist{$uname}[ $stuid ]}} ) {                          foreach my $match (@{$unameFromINid{$$currlist{$uname}[ $stuid ]}} ) {
                             $$logmsg .= "A possible change in username has been detected for a student enrolled in $crs. The existing LON-CAPA classlist contains user: $uname and student ID: $$currlist{$uname}[ $place{studentID} ].  This username has been dropped from the institutional classlist, but the same student ID is used for user: $match who still appears in the institutional classlist. You may need to move the student data files for user: $uname to $match.".$linefeed;                              $$logmsg .= "A possible change in username has been detected for a student enrolled in this course. The existing LON-CAPA classlist contains user: $uname and student ID: $$currlist{$uname}[ $place{studentID} ].  This username has been dropped from the institutional classlist, but the same student ID is used for user: $match who still appears in the institutional classlist. You may need to move the student data files for user: $uname to $match.".$linefeed;
                             push @saved,$uname;                              push @saved,$uname;
                         }                          }
                     } elsif (@saved == 0) {                      } elsif (@saved == 0) {
Line 353  sub update_LC { Line 402  sub update_LC {
                             $dropcount ++;                              $dropcount ++;
                             my %userenv = &Apache::lonnet::get('environment',['firstname','lastname','id'],$dom,$uname);                              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;                               $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;
                               }
                         }                          }
                     }                      }
                 }                  }
Line 366  sub update_LC { Line 418  sub update_LC {
     }      }
     if ($enrollcount > 0) {      if ($enrollcount > 0) {
         if ($context eq "updatenow") {          if ($context eq "updatenow") {
               $addresult = substr($addresult,0,rindex($addresult,"<li>"));
             $addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:<br/><ul><li>".$addresult."</li></ul><br/><br/>";              $addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:<br/><ul><li>".$addresult."</li></ul><br/><br/>";
         } else {          } else {
             $addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:\n\n".$addresult."\n\n";                  $addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:\n\n".$addresult."\n\n";    
Line 373  sub update_LC { Line 426  sub update_LC {
     }      }
     if ($dropcount > 0) {      if ($dropcount > 0) {
         if ($context eq "updatenow") {          if ($context eq "updatenow") {
               $dropresult = substr($dropresult,0,rindex($dropresult,"<li>"));
             $dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:<br/><ul><li>".$dropresult."</li></ul><br/><br/>";              $dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:<br/><ul><li>".$dropresult."</li></ul><br/><br/>";
         } else {          } else {
             $dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:\n\n".$dropresult."\n\n";              $dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:\n\n".$dropresult."\n\n";
Line 396  sub update_LC { Line 450  sub update_LC {
     }      }
     my $changecount = $enrollcount + $dropcount;      my $changecount = $enrollcount + $dropcount;
     return ($changecount,$addresult.$dropresult);       return ($changecount,$addresult.$dropresult); 
 }   }
   
 sub parse_classlist {  sub parse_classlist {
     my ($tmpdir,$dom,$crs,$class,$placeref,$groupID,$studentsref) = @_;                  my ($tmpdir,$dom,$crs,$class,$placeref,$groupID,$studentsref) = @_;
     my $configvars = &LONCAPA::Configuration::read_conf();  
     my $xmlfile = $tmpdir."/tmp/".$dom."_".$crs."_".$class."_classlist.xml";      my $xmlfile = $tmpdir."/tmp/".$dom."_".$crs."_".$class."_classlist.xml";
     my $enrolled = XMLin( $xmlfile, KeyAttr => ['username'] );      my $uname = '';
     foreach my $uname ( sort keys %{$$enrolled{'student'}} ) {      my @state;
         @{ $$studentsref{$uname} } = ();      my @items = ('autharg','authtype','email','firstname','generation','lastname','middlename','studentID');
         foreach my $key (sort keys %{$$enrolled{'student'}{$uname}} ) {      my $p = HTML::Parser->new
             my $value = $$enrolled{'student'}{$uname}{$key};      (
             if (ref($value)) {          xml_mode => 1,
                 $$studentsref{$uname}[ $$placeref{$key} ] = '';          start_h =>
             } else {              [sub {
                 if ($key eq 'groupID') {                   my ($tagname, $attr) = @_;
                     $$studentsref{$uname}[ $$placeref{$key} ] = $groupID;                   push @state, $tagname;
                 } else {                   if ("@state" eq "students student") {
                     $$studentsref{$uname}[ $$placeref{$key} ] = $value;                       $uname = $attr->{username};
                 }                   }
               }, "tagname, attr"],
            text_h =>
                [sub {
                    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") {
                                $$studentsref{$uname}[ $$placeref{$item} ] = $text;
                            }
                        }
                    }
                  }, "dtext"],
            end_h =>
                  [sub {
                      my ($tagname) = @_;
                      pop @state;
                   }, "tagname"],
       );
                                                                                                                
       $p->parse_file($xmlfile);
       $p->eof;
       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]);
     }      }
 #    if (-e "$xmlfile") {      return $timestamp;
 #        unlink $xmlfile;  
 #    }  
     return;  
 }  }
   
 sub create_password {  sub create_password {
     my ($authparam,$create_passwd,$authreply);      my $passwd = '';
     return ($authparam,$create_passwd,$authreply);      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; }  sub CL_autharg { return 0; }
Removed from v.1.5  
changed lines
  Added in v.1.9

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>