[LON-CAPA-cvs] cvs: loncom /enrollment Enrollment.pm

raeburn lon-capa-cvs@mail.lon-capa.org
Tue, 09 Dec 2003 00:31:51 -0000


This is a MIME encoded message

--raeburn1070929911
Content-Type: text/plain

raeburn		Mon Dec  8 19:31:51 2003 EDT

  Modified files:              
    /loncom/enrollment	Enrollment.pm 
  Log:
  Classlist now parsed with HTML::Parser instead of XML::Simple. A few other cosmetic changes.
  
  
--raeburn1070929911
Content-Type: text/plain
Content-Disposition: attachment; filename="raeburn-20031208193151.txt"

Index: loncom/enrollment/Enrollment.pm
diff -u loncom/enrollment/Enrollment.pm:1.5 loncom/enrollment/Enrollment.pm:1.6
--- loncom/enrollment/Enrollment.pm:1.5	Mon Dec  8 10:51:40 2003
+++ loncom/enrollment/Enrollment.pm	Mon Dec  8 19:31:51 2003
@@ -3,7 +3,6 @@
 use Apache::loncoursedata;
 use Apache::lonnet;
 use HTML::Entities;
-use XML::Simple;
 use LONCAPA::Configuration;
 
 use strict;
@@ -114,7 +113,7 @@
                     $$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 +147,7 @@
 # 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 +156,7 @@
                     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 +168,7 @@
                     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 +230,12 @@
                             }
                         } 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 +243,9 @@
                             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 +296,7 @@
                         }
 # 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 +324,9 @@
                         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 +344,7 @@
 # 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 +368,7 @@
     }
     if ($enrollcount > 0) {
         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/>";
         } else {
             $addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:\n\n".$addresult."\n\n";    
@@ -373,6 +376,7 @@
     }
     if ($dropcount > 0) {
         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/>";
         } else {
             $dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:\n\n".$dropresult."\n\n";
@@ -396,28 +400,47 @@
     }
     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;
 #    }

--raeburn1070929911--