--- loncom/enrollment/Enrollment.pm 2003/12/08 15:51:40 1.5
+++ loncom/enrollment/Enrollment.pm 2003/12/09 20:06:37 1.7
@@ -1,9 +1,33 @@
+# Automated Enrollment manager
+# $Id: Enrollment.pm,v 1.7 2003/12/09 20:06:37 albertel 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 HTML::Entities;
-use XML::Simple;
use LONCAPA::Configuration;
use strict;
@@ -114,7 +138,7 @@ sub update_LC {
$$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 {
@{$enrollinfo{$uname}} = @{$allenrolled{$uname}[0]};
@@ -148,7 +172,7 @@ sub update_LC {
# Check for studentID changes
if ( ($uidhash{$uname}) && ($uidhash{$uname} !~ /error\:/) ) {
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;
}
}
@@ -157,7 +181,7 @@ sub update_LC {
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} ]." in class $crs".$linefeed;
+ $$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;
}
@@ -169,7 +193,7 @@ sub update_LC {
if (grep/^$$currlist{$uname}[ $place{'studentID'} ]$/,@allINids) {
foreach my $match ( @{ $unameFromLCid{ $stuinfo[ $place{studentID} ] } } ) {
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;
}
}
}
@@ -231,12 +255,12 @@ sub update_LC {
}
} elsif ($authtype =~ m/^krb/) {
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';
}
} else {
$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') {
# Now create user.
@@ -244,7 +268,9 @@ sub update_LC {
if ($reply eq 'ok') {
$enrollcount ++;
$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.".$linefeed;
+ }
unless ($emailenc eq '') {
my %emailHash;
$emailHash{'critnotification'} = $emailenc;
@@ -295,7 +321,7 @@ sub update_LC {
}
# Report if authentication methods are different.
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
if ($first ne $userenv{'firstname'} ||
@@ -323,8 +349,9 @@ sub update_LC {
if ($classlist_reply eq 'ok') {
$enrollcount ++;
$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 {
$$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;
}
@@ -342,7 +369,7 @@ sub update_LC {
# Check for changed usernames by checking studentIDs
if (grep/^$$currlist{$uname}[ $stuid ]$/,@allINids) {
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;
}
} elsif (@saved == 0) {
@@ -366,6 +393,7 @@ sub update_LC {
}
if ($enrollcount > 0) {
if ($context eq "updatenow") {
+ $addresult = substr($addresult,0,rindex($addresult,""));
$addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:
";
} else {
$addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:\n\n".$addresult."\n\n";
@@ -373,6 +401,7 @@ sub update_LC {
}
if ($dropcount > 0) {
if ($context eq "updatenow") {
+ $dropresult = substr($dropresult,0,rindex($dropresult,""));
$dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:
";
} else {
$dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:\n\n".$dropresult."\n\n";
@@ -396,28 +425,47 @@ sub update_LC {
}
my $changecount = $enrollcount + $dropcount;
return ($changecount,$addresult.$dropresult);
-}
+}
sub parse_classlist {
- my ($tmpdir,$dom,$crs,$class,$placeref,$groupID,$studentsref) = @_;
- my $configvars = &LONCAPA::Configuration::read_conf();
+ my ($tmpdir,$dom,$crs,$class,$placeref,$groupID,$studentsref) = @_;
my $xmlfile = $tmpdir."/tmp/".$dom."_".$crs."_".$class."_classlist.xml";
- my $enrolled = XMLin( $xmlfile, KeyAttr => ['username'] );
- foreach my $uname ( sort keys %{$$enrolled{'student'}} ) {
- @{ $$studentsref{$uname} } = ();
- foreach my $key (sort keys %{$$enrolled{'student'}{$uname}} ) {
- my $value = $$enrolled{'student'}{$uname}{$key};
- if (ref($value)) {
- $$studentsref{$uname}[ $$placeref{$key} ] = '';
- } else {
- if ($key eq 'groupID') {
- $$studentsref{$uname}[ $$placeref{$key} ] = $groupID;
- } else {
- $$studentsref{$uname}[ $$placeref{$key} ] = $value;
- }
- }
- }
- }
+ my $uname = '';
+ my @state;
+ my @items = ('autharg','authtype','email','enddate','firstname','generation','lastname','middlename','startdate','studentID');
+ my $p = HTML::Parser->new
+ (
+ xml_mode => 1,
+ start_h =>
+ [sub {
+ my ($tagname, $attr) = @_;
+ push @state, $tagname;
+ if ("@state" eq "students student") {
+ $uname = $attr->{username};
+ }
+ }, "tagname, attr"],
+ text_h =>
+ [sub {
+ my ($text) = @_;
+ if ("@state" eq "students student groupID") {
+ $$studentsref{$uname}[ $$placeref{'groupID'} ] = $groupID;
+ } 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;
# }