--- loncom/enrollment/Enrollment.pm 2005/01/30 01:07:35 1.21 +++ loncom/enrollment/Enrollment.pm 2013/07/24 18:21:49 1.45 @@ -1,5 +1,5 @@ # Automated Enrollment manager -# $Id: Enrollment.pm,v 1.21 2005/01/30 01:07:35 raeburn Exp $ +# $Id: Enrollment.pm,v 1.45 2013/07/24 18:21:49 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,7 +27,9 @@ package LONCAPA::Enrollment; use Apache::loncoursedata; use Apache::lonnet; +use Apache::loncommon(); use Apache::lonmsg; +use Apache::lonlocal; use HTML::Entities; use LONCAPA::Configuration; use Time::Local; @@ -36,14 +38,16 @@ use lib '/home/httpd/lib/perl'; use strict; sub update_LC { - my ($dom,$crs,$adds,$drops,$startdate,$enddate,$authtype,$autharg,$classesref,$groupref,$logmsg,$newusermsg,$context) = @_; + my ($dom,$crs,$adds,$drops,$startdate,$enddate,$authtype,$autharg, + $showcredits,$defaultcredits,$classesref,$groupref,$logmsg,$newusermsg, + $context,$phototypes) = @_; # Get institutional code and title of this class my %courseinfo = (); &get_courseinfo($dom,$crs,\%courseinfo); # Get current LON-CAPA student enrollment for this class my $configvars = &LONCAPA::Configuration::read_conf('loncapa.conf'); my $cid = $dom."_".$crs; - my $roster = &Apache::loncoursedata::get_classlist($cid,$dom,$crs); + my $roster = &Apache::loncoursedata::get_classlist($dom,$crs); my $cend = &Apache::loncoursedata::CL_END; my $cstart = &Apache::loncoursedata::CL_START; my $stuid=&Apache::loncoursedata::CL_ID; @@ -51,6 +55,7 @@ sub update_LC { my $status=&Apache::loncoursedata::CL_STATUS; my $type=&Apache::loncoursedata::CL_TYPE; my $lockedtype=&Apache::loncoursedata::CL_LOCKEDTYPE; + my $credidx=&Apache::loncoursedata::CL_CREDITS; my @localstudents = (); my @futurestudents = (); my @activestudents = (); @@ -75,6 +80,7 @@ sub update_LC { my $addresult = ''; my $dropresult = ''; my $switchresult = ''; + my $photoresult = ''; if ($context eq "updatenow") { $linefeed = "\n
  • "; } elsif ($context eq "automated") { @@ -89,9 +95,17 @@ sub update_LC { open(FILE,"<$$configvars{'lonTabDir'}.'/rolesplain.tab"); my @rolesplain = ; close(FILE); - foreach (@rolesplain) { - if ($_ =~ /^(st|ta|ex|ad|in|cc):([\w\s]+)$/) { - $longroles{$1} = $2; + foreach my $item (@rolesplain) { + if ($_ =~ /^(st|ta|ex|ad|in|cc|co):([\w\s]+):?([\w\s]*)/) { + if ($courseinfo{'type'} eq 'Community') { + unless($1 eq 'cc') { + $longroles{$1} = $3; + } + } else { + unless($1 eq 'co') { + $longroles{$1} = $2; + } + } } } @@ -112,18 +126,7 @@ sub update_LC { # Get latest institutional enrollment for this class. my %allenrolled = (); my @reg_students = (); - my %place = (); - $place{'autharg'} = &CL_autharg(); - $place{'authtype'} = &CL_authtype(); - $place{'email'} = &CL_email(); - $place{'enddate'} = &CL_enddate(); - $place{'firstname'} = &CL_firstname(); - $place{'generation'} = &CL_generation(); - $place{'groupID'} = &CL_groupID(); - $place{'lastname'} = &CL_lastname(); - $place{'middlename'} = &CL_middlename(); - $place{'startdate'} = &CL_startdate(); - $place{'studentID'} = &CL_studentID(); + my %place = &place_hash(); my %ucount = (); my %enrollinfo = (); foreach my $class (@{$classesref}) { @@ -144,7 +147,7 @@ sub update_LC { my @okusers = (); foreach my $uname (@reg_students) { if (grep/^$uname$/,@excludedstudents) { - $$logmsg .= "No re-enrollment for $uname - user was previously manually unenrolled and locked.".$linefeed; + $$logmsg .= &mt('No re-enrollment for [_1] - user was previously manually unenrolled and locked.',$uname).$linefeed; } elsif (@{$allenrolled{$uname}} > 1) { my @sections = (); my $saved; @@ -167,19 +170,19 @@ sub update_LC { push @okusers, $uname; } elsif (@sections > 1) { - $$logmsg = "$uname appears in classlists for the more than one section of this course, i.e. in sections: "; + $$logmsg .= &mt('[_1] appears in classlists for more than one section of this course, i.e. in sections: ',$uname); foreach (@sections) { $$logmsg .= " $_,"; } chop($$logmsg); - $$logmsg .= ". Because of this ambiguity, no enrollment action was taken for this student.".$linefeed; + $$logmsg .= '. '.&mt('Because of this ambiguity, no enrollment action was taken for this student.').$linefeed; } } else { @{$enrollinfo{$uname}} = @{$allenrolled{$uname}[0]}; push @okusers, $uname; } } -# Get mapping of student IDs to usernames for users in institutional data for this class +# Get mapping of student/employee IDs to usernames for users in institutional data for this class my @allINids = (); my %unameFromINid = (); foreach my $uname (@okusers) { @@ -192,9 +195,10 @@ sub update_LC { @{$unameFromINid{$stuID}} = $uname; } } + # Explicitly allow access to creation/modification of students if called as an automated process. if ($context eq 'automated') { - $ENV{'allowed.cst'}='F'; + $env{'allowed.cst'}='F'; } # Compare IDs with existing LON-CAPA enrollment for this class @@ -202,47 +206,70 @@ sub update_LC { unless ($uname eq '') { my %uidhash=&Apache::lonnet::idrget($dom,$uname); my @stuinfo = @{$enrollinfo{$uname}}; - my $access = ''; + my ($access,$added,$inststatus); + my $credits; + if ($showcredits) { + $credits = $stuinfo[$place{'credits'}]; + $credits =~ s/[^\d\.]//g; + if ($credits eq $defaultcredits) { + undef($credits); + } + } + $inststatus = $stuinfo[$place{inststatus}]; if (grep/^$uname$/,@localstudents) { # Check for studentID changes if ( ($uidhash{$uname}) && ($uidhash{$uname} !~ /error\:/) ) { unless ( ($uidhash{$uname}) eq ($stuinfo[ $place{studentID} ]) ) { - $$logmsg .= "Change in ID for $uname. StudentID in LON-CAPA system is $uidhash{$uname}; StudentID in institutional data is $stuinfo[ $place{studentID} ]".$linefeed; + $$logmsg .= &mt('Change in ID for [_1]. StudentID in LON-CAPA system is [_2]; StudentID in institutional data is [_3].',$uname,$uidhash{$uname},$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); + my $drop_reply = &Apache::lonnet::modifystudent($dom,$uname,'','','',undef,undef,undef,undef,$$currlist{$uname}[$sec],time,undef,undef,undef,undef,'auto','',$cid,'',$context); # 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; + $$logmsg .= &mt('An error occured during the attempt to convert [_1] from a manual type to an auto type student - [_2].',$uname,$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) { - $switchresult .= "Section for $uname switched from $$currlist{$uname}[$sec] to ".$usec.$linefeed; + my $showoldsec = $$currlist{$uname}[$sec]; + if ($$currlist{$uname}[$sec] eq '') { + $showoldsec = &mt('none'); + } + my $showsec = $usec; + if ($usec eq '') { + $showsec = &mt('none'); + } + $switchresult .= &mt('Section for [_1] switched from [_2] to [_3].',$uname,$showoldsec,$showsec).$linefeed; if ($context eq 'automated') { - $$logmsg .= "Section switch for $uname from $$currlist{$uname}[$sec] to ".$usec.$linefeed; ; + $$logmsg .= &mt('Section switch for [_1] from [_2] to [_3].',$uname,$showoldsec,$usec).$linefeed; } $switchcount ++; } - &execute_add($context,'switchtype',$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$cid,\$addresult,\$enrollcount,$linefeed,$logmsg); + &execute_add($context,'switchtype',$uname,$dom,$auth, + $authparam,$first,$middle,$last,$gene, + $pid,$usec,$end,$start,$emailenc, + $credits,$cid,\$addresult,\$enrollcount, + $linefeed,$logmsg); + $added = 1; } - } + } # 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 = &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,'',$context,$credits); $access = &showaccess($enddate,$startdate); if ($modify_access_result =~ /^ok/) { - $$logmsg .= "Change in access dates for $uname.".$access.$linefeed; + $$logmsg .= &mt('Change in access dates for [_1].',$uname).$access.$linefeed; + $added = 1; } else { - $$logmsg .= "Error when attempting to change start and/or end access dates for $uname in section: ".$stuinfo[ $place{groupID} ]." -error $modify_access_result".$linefeed; + $$logmsg .= &mt('Error when attempting to change start and/or end access dates for [_1] in section: [_2] -error [_3].',$uname,$stuinfo[$place{groupID}],$modify_access_result).$linefeed; } } } @@ -255,41 +282,61 @@ sub update_LC { if ($$currlist{$uname}[$sec]) { $uurl.='/'.$$currlist{$uname}[$sec]; } - my $expire_role_result = &Apache::lonnet::assignrole($dom,$uname,$uurl,'st',$expiretime); + my $expire_role_result = &Apache::lonnet::assignrole($dom,$uname,$uurl,'st',$expiretime,'','','',$context); 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,'',$context,$credits); } 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,'',$context,$credits); $access = &showaccess($enddate,$startdate); } if ($modify_section_result =~ /^ok/) { - $switchresult .= "Section for $uname switched from old section: ".$$currlist{$uname}[$sec] ." to new section: ".$stuinfo[ $place{groupID} ].".".$access.$linefeed; + $switchresult .= &mt('Section for [_1] switched from old section: [_2] to new section: [_3].',$uname,$$currlist{$uname}[$sec],$stuinfo[ $place{groupID} ]).$access.$linefeed; + $added = 1; if ($context eq 'automated') { - $$logmsg .= "Section switch for $uname from $$currlist{$uname}[$sec] to $stuinfo[ $place{groupID} ]".$linefeed; + $$logmsg .= &mt('Section switch for [_1] from [_2] to [_3].',$uname,$$currlist{$uname}[$sec],$stuinfo[ $place{groupID} ]).$linefeed; } $switchcount ++; } 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 .= &mt("Error when attempting section change for [_1], from old section: '[_2]' to new section: '[_3]' -error: [_4]",$uname,$$currlist{$uname}[$sec],$stuinfo[ $place{groupID} ],$modify_section_result).$linefeed; } } else { - $$logmsg .= "Error when attempting to expire role for $uname in old section" .$$currlist{$uname}[$sec]." -error: $expire_role_result".$linefeed; + $$logmsg .= &mt("Error when attempting to expire role for [_1] in old section: '[_2]' -error: '[_3]'.",$uname,$$currlist{$uname}[$sec],$expire_role_result).$linefeed; + } + } + } +# Check for credits changes + if (($showcredits) && + ($$currlist{$uname}[$credidx] ne $credits) && (!$added)) { + my $modify_credits_result = + &Apache::lonnet::modify_student_enrollment($dom,$uname,undef,undef,undef,undef,undef,$stuinfo[ $place{groupID} ],$enddate,$startdate,'auto','',$cid,'',$context,$credits); + if ($modify_credits_result =~ /^ok/) { + if ($credits ne '') { + $$logmsg .= &mt('Credits change for [_1] from [_2] to [_3].',$uname,$$currlist{$uname}[$credidx],$credits).$linefeed; + } else { + $$logmsg .= &mt('Credits change for [_1] from [_2] to course default [_3].',$uname,$$currlist{$uname}[$credidx],$defaultcredits).$linefeed; } + } else { + $$logmsg .= &mt('Error when attempting to change credits for [_1] in section: [_2] -error [_3].',$uname,$stuinfo[$place{groupID}],$modify_credits_result).$linefeed; } } } else { # Check for changed usernames by checking studentIDs if ( ($stuinfo[ $place{studentID} ] ne '') && (grep/^$stuinfo[ $place{studentID} ]$/,@LCids) ) { - 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 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; + foreach my $match ( @{ $unameFromLCid{ $stuinfo[ $place{studentID} ] } } ) { + $$logmsg .= &mt('A possible change in username has been detected for a student enrolled in this course.').' '.&mt('The existing LON-CAPA classlist contains user: [_1] and student/employee ID: [_2].',$match,$stuinfo[ $place{studentID} ]); + if (grep/^$match$/,@okusers) { + $$logmsg .= &mt('The username [_1] remains in the institutional classlist, but the same student/employee ID is used for new user: [_2] now found in the institutional classlist.',$match,$uname).' '.&mt('You may need to contact your Domain Coordinator to determine how to resolve this issue and whether to move student data files for user: [_1] to [_2].',$match,$uname).' '; + } else { + unless ($drops == 1) { + $$logmsg .= &mt('This username - [_1] - has been dropped from the institutional classlist, but the student/employee ID of this user is also used by [_2] who now appears in the institutional classlist.',$match,$uname).' '.&mt('You may need to contact your Domain Coordinator to request a move of the student data files for user: [_1] to [_2].',$match,$uname).' '; } } + $$logmsg .= &mt('Because of this student/employee ID conflict, the new username - [_1] - has not been added to the LON-CAPA classlist',$uname).$linefeed; } } elsif ($adds == 1) { - my ($auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,$emailaddr,$pid,$emailenc); + my ($auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,$emailaddr,$pid,$emailenc,$credithours); &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); @@ -313,16 +360,60 @@ sub update_LC { 'cdom' => $dom, 'context' => $context, 'linefeed' => $linefeed, - 'role' => 'st' + 'inststatus' => $inststatus, + 'role' => 'st', }; - my $outcome = &create_newuser($args,$logmsg,$newusermsg,\$enrollcount,\$addresult,\%longroles,\%courseinfo); + if ($credits) { + $args->{'credits'} = $credits; + } + my $outcome = &create_newuser($args,$logmsg,$newusermsg,\$enrollcount,\$addresult,\%longroles,\%courseinfo,$context); + } else { + &execute_add($context,'newstudent',$uname,$dom,$auth, + $authparam,$first,$middle,$last,$gene,$pid, + $usec,$end,$start,$emailenc,$credits, + $cid,\$addresult,\$enrollcount,$linefeed, + $logmsg); + } + if ($courseinfo{'showphoto'}) { + my ($result,$resulttype) = + &Apache::lonnet::auto_checkphotos($uname,$dom,$pid); + if ($resulttype) { + push(@{$$phototypes{$resulttype}},$uname); + } + } + } + } + } + } + if ($courseinfo{'showphoto'}) { + if (keys(%{$phototypes})>0) { + my %lt = &photo_response_types(); + foreach my $type (sort(keys(%{$phototypes}))) { + my $numphoto = @{$$phototypes{$type}}; + if ($numphoto > 0) { + if ($context eq 'updatenow') { + $photoresult .= '
    '. + &mt('For [_1] students, photos ',$numphoto). + $lt{$type}.'
    '; } else { - &execute_add($context,'newstudent',$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$cid,\$addresult,\$enrollcount,$linefeed,$logmsg); + $photoresult .= "\n"; } } } } } + # Do drops if ( ($drops == 1) && (@reg_students > 0) ) { foreach my $uname (@localstudents) { @@ -332,19 +423,19 @@ 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 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; + $$logmsg .= &mt('A possible change in username has been detected for a student enrolled in this course.').' '.&mt('The existing LON-CAPA classlist contains user: [_1] and student/employee ID: [_2].',$uname,$$currlist{$uname}[ $place{studentID} ]).' '.&mt('This username has been dropped from the institutional classlist, but the same student/employee ID is used for user: [_1] who still appears in the institutional classlist.',$match).' '.&mt('You may need to move the student data files for user: [_1] to [_2]',$uname,$match).' '.&mt('Because of this, user [_1] has not been dropped from the course.',$uname).$linefeed; 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,'',$context); 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; + $$logmsg .= &mt('An error occured during the attempt to expire the [_1] from the old section [_2] - [_3].',$uname,$$currlist{$uname}[$sec],$drop_reply).$linefeed; } else { $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; + $dropresult .= $userenv{'firstname'}." ".$userenv{'lastname'}." (".$userenv{'id'}.") - ".$uname.' '.&mt("dropped from section: '[_1]'.",$$currlist{$uname}[$sec]).$linefeed; if ($context eq 'automated') { - $$logmsg .= "User $uname student role expired from course.".$linefeed; + $$logmsg .= &mt('User [_1] student role expired from course.',$uname).$linefeed; } } } @@ -355,34 +446,34 @@ sub update_LC { # Terminated explictly allowed access to student creation/modification if ($context eq 'automated') { - delete($ENV{'allowed.cst'}); + delete($env{'allowed.cst'}); } 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:


    "; + $addresult = &mt("The following [quant,_1,student was,students were] added to this LON-CAPA course:",$enrollcount).'


    '; } else { - $addresult = "The following $enrollcount student(s) was/were added to this LON-CAPA course:\n\n".$addresult."\n\n"; + $addresult = &mt("The following [quant,_1,student was,students were] added to this LON-CAPA course:",$enrollcount)."\n\n".$addresult."\n\n"; } } 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:


    "; + $dropresult = &mt("The following [quant,_1,student was,students were] expired from this LON-CAPA course:",$dropcount).'


    '; } else { - $dropresult = "The following $dropcount student(s) was/were expired from this LON-CAPA course:\n\n".$dropresult."\n\n"; + $dropresult = &mt("The following [quant,_1,student was,students were] expired from this LON-CAPA course:",$dropcount)."\n\n".$dropresult."\n\n"; } } if ($switchcount > 0) { if ($context eq "updatenow") { $switchresult = substr($switchresult,0,rindex($switchresult,"
  • ")); - $switchresult = "The following $switchcount student(s) switched sections in this LON-CAPA course:


    "; + $switchresult = &mt("The following [quant,_1,student] switched sections in this LON-CAPA course:",$switchcount).'


    '; } else { - $switchresult = "The following $switchcount student(s) switched sections in this LON-CAPA course:\n\n".$switchresult."\n\n"; + $switchresult = &mt("The following [quant,_1,student] switched sections in this LON-CAPA course:",$switchcount)."\n\n".$switchresult."\n\n"; } } if ( ($adds) && ($enrollcount == 0) ) { - $addresult = "There were no new students to add to the course."; + $addresult = &mt('There were no new students to add to the course.'); if ($context eq "updatenow") { $addresult .="

    "; } else { @@ -390,7 +481,7 @@ sub update_LC { } } if ( ($drops) && ($dropcount == 0) ) { - $dropresult = "There were no students with roles to expire because all active students previously added to the course from institutional classlist(s) are still officially registered."; + $dropresult = &mt('There were no students with roles to expire because all active students previously added to the course from institutional classlist(s) are still officially registered.'); if ($context eq "updatenow") { $dropresult .="
    "; } else { @@ -398,11 +489,12 @@ sub update_LC { } } my $changecount = $enrollcount + $dropcount + $switchcount; - return ($changecount,$addresult.$dropresult.$switchresult); + return ($changecount,$addresult.$photoresult.$dropresult.$switchresult); } sub create_newuser { - my ($args,$logmsg,$newusermsg,$enrollcount,$addresult,$longroles,$courseinfo) = @_; + my ($args,$logmsg,$newusermsg,$enrollcount,$addresult,$longroles, + $courseinfo,$called_context) = @_; my $auth = $args->{'auth'}; my $authparam = $args->{'authparam'}; my $emailenc = $args->{'emailenc'}; @@ -423,6 +515,8 @@ sub create_newuser { my $context = $args->{'context'}; my $linefeed = $args->{'linefeed'}; my $role = $args->{'role'}; + my $inststatus = $args->{'inststatus'}; + my $credits = $args->{'credits'}; my $create_passwd = 0; my $authchk = ''; my $outcome; @@ -439,16 +533,16 @@ sub create_newuser { } } } elsif ($auth eq "localauth") { - ($authparam,$create_passwd,$authchk) = &Apache::lonnet::auto_create_password($crs,$cdom,$authparam); + ($authparam,$create_passwd,$authchk) = &Apache::lonnet::auto_create_password($crs,$cdom,$authparam,$udom); } elsif ($auth =~ m/^krb/) { if ($authparam eq '') { - $$logmsg .= "No Kerberos domain was provided for the new user - $uname, so the new user was not enrolled in the course.".$linefeed; + $$logmsg .= &mt('No Kerberos domain was provided for the new user - [_1], so the new user was not enrolled in the course',$uname).$linefeed; $authchk = 'invalid'; } } else { $authchk = 'invalid'; - $$logmsg .= "An invalid authentication type was provided for the new user - $uname, so the user was not enrolled in the course.".$linefeed; - } + $$logmsg .= &mt('An invalid authentication type was provided for the new user - [_1], so the user was not enrolled in the course.',$uname).$linefeed; + } if ($authchk eq 'ok') { # Now create user. my $type = 'auto'; @@ -459,7 +553,7 @@ sub create_newuser { if ($context eq 'createowner' || $context eq 'createcourse') { my $result = &Apache::lonnet::modifyuser($udom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,'1',undef,$emailaddr); if ($result eq 'ok' && $context eq 'createcourse') { - $outcome = &Apache::loncreateuser::commit_standardrole($userurl,$role,$cdom,$crs,$start,$end); + $outcome = &Apache::loncommon::commit_standardrole($udom,$uname,$userurl,$role,$start,$end,$cdom,$crs,$usec,$called_context); unless ($outcome =~ /^Error:/) { $outcome = 'ok'; } @@ -467,21 +561,26 @@ sub create_newuser { $outcome = $result; } } else { - $outcome=&Apache::lonnet::modifystudent($udom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,'',undef,$emailaddr,'auto','',$cid); + $outcome=&Apache::lonnet::modifystudent($udom,$uname,$pid,$auth,$authparam,$first,$middle,$last,$gene,$usec,$end,$start,'',undef,$emailaddr,'auto','',$cid,'',$called_context,$inststatus,$credits); } if ($outcome eq 'ok') { my $access = &showaccess($end,$start); - $$addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$access.$linefeed; + my $showsec = $usec; + if ($usec eq '') { + $showsec = &mt('none'); + } + $$addresult .= "$first $last ($pid) - $uname ".&mt("enrolled in section: '[_1]'.",$showsec).$access.$linefeed; unless ($context eq 'createowner' || $context eq 'createcourse') { $$enrollcount ++; } - if ($context eq 'automated') { - $$logmsg .= "New $udom user $uname added successfully."; + if ($called_context eq 'automated') { + $$logmsg .= &mt('New [_1] user [_2] added successfully.',$udom,$uname); } unless ($emailenc eq '' || $context eq 'createowner' || $context eq 'createcourse') { my %emailHash; $emailHash{'critnotification'} = $emailenc; $emailHash{'notification'} = $emailenc; + $emailHash{'permanentemail'} = $emailenc; my $putresult = &Apache::lonnet::put('environment',\%emailHash,$udom,$uname); } if ($create_passwd) { @@ -489,34 +588,52 @@ sub create_newuser { # 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"; + $$newusermsg .= &mt(' username: [_1], password: [_2]',$uname,$authparam).$linefeed."\n"; } else { - my $subject = "New LON-CAPA account"; + my $subject = &mt('New LON-CAPA account'); my $body; + my $portalurl = 'http://'.$ENV{'SERVER_NAME'}; + my $protocol = 'http'; + my $lonhost=&Apache::lonnet::domain($udom,'primary'); + if ($lonhost ne '') { + my $ip = &Apache::lonnet::get_host_ip($lonhost); + if ($Apache::lonnet::protocol{$lonhost} eq 'https') { + $protocol = 'https'; + } + if ($ip ne '') { + $portalurl = $protocol.'://'.$ip + } + } if ($context eq 'createowner') { - $body = "A user account has been created for you while creating your new course in 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'}."\n\n"; + $body = &mt('A user account has been created for you while creating your new course in the LON-CAPA course management and online homework system.')."\n\n".&mt('You should log-in to the system using the following credentials:')."\n".&mt('username: ').$uname."\n".&mt('password: ').$authparam."\n\n".&mt('The URL you should use to access the LON-CAPA system at your institution is: ').$portalurl."\n\n"; } elsif ($context eq 'createcourse') { - $body = "You have been assigned the role of $$longroles{$role} in a new course: $$courseinfo{'description'} - $$courseinfo{'inst_code'} in the LON-CAPA course management and online homework system. As you did not have an existing user account in the system, one has been created for you.\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'}."\n\n"; + $body = &mt('You have been assigned the role of [_1] in a new course: [_2] - [_3] in the LON-CAPA course management and online homework system.',$$longroles{$role},$$courseinfo{'description'},$$courseinfo{'inst_code'}).' '.&mt('As you did not have an existing user account in the system, one has been created for you.')."\n\n".&mt("You should log-in to the system using the following credentials:\nusername: [_1]\npassword: [_2]",$uname,$authparam)."\n\n".&mt('The URL you should use to access the LON-CAPA system at your institution is: ').$portalurl."\n\n"; } else { my $access_start = 'immediately'; if ($start > 0) { $access_start = localtime($start) } - $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 couse 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'}."\n\n.When you log-in you will be able to access the LON-CAPA course for $$courseinfo{'description'} - $$courseinfo{'inst_code'} starting $access_start.\n"; + $body = + &mt('You have been enrolled in the LON-CAPA system at your institution, because you are a registered student in a class which is using the LON-CAPA course management and online homework system.')."\n\n" + .&mt("You should log-in to the system using the following credentials:\nusername: [_1]\npassword: [_2]",$uname,$authparam)."\n\n" + .&mt('The URL you should use to access the LON-CAPA system at your institution is: ').$portalurl."\n\n" + .&mt('When you log-in you will be able to access the LON-CAPA course for [_1] - [_2] starting [_3].',$$courseinfo{'description'},$$courseinfo{'inst_code'},$access_start)."\n"; } &Apache::lonmsg::sendemail($emailaddr,$subject,$body); } - if ($context eq 'automated') { - $$logmsg .= " Initial password - - sent to ".$emailaddr.$linefeed; + if ($called_context eq 'automated') { + $$logmsg .= &mt(' Initial password - sent to ').$emailaddr.$linefeed; } } else { - if ($context eq 'automated') { + if ($called_context eq 'automated') { $$logmsg .= $linefeed; } } } else { - $$logmsg .= "An error occurred adding new user $uname - ".$outcome.$linefeed; + $$logmsg .= &mt('An error occurred adding new user [_1] - [_2].',$uname,$outcome).$linefeed; } + } else { + $$logmsg .= &mt('An error occurred adding the new user [_1] because the authcheck failed for authtype [_2] and parameter [_3].',$uname,$auth,$authparam).' '.&mt('The authcheck response was [_1].',$authchk).$linefeed; } return $outcome; } @@ -562,9 +679,11 @@ sub prepare_add { } sub execute_add { - my ($context,$caller,$uname,$dom,$auth,$authparam,$first,$middle,$last,$gene,$pid,$usec,$end,$start,$emailenc,$cid,$addresult,$enrollcount,$linefeed,$logmsg) = @_; + my ($context,$caller,$uname,$dom,$auth,$authparam,$first,$middle,$last, + $gene,$pid,$usec,$end,$start,$emailenc,$credits,$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 %userenv = &Apache::lonnet::get('environment',['firstname','middlename','lastname','generation','id','critnotification','notification','permanentemail','inststatus'],$dom,$uname); my ($tmp) = keys(%userenv); if ($tmp =~ /^(con_lost|error)/i) { %userenv = (); @@ -572,14 +691,22 @@ sub execute_add { # 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; + $$logmsg .= &mt('Current critical notification e-mail - [_1] for [_2] is different to e-mail address in institutional classlist - [_3].', + $userenv{critnotification},$uname,$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; + unless ($emailenc eq $userenv{notification}) { + $$logmsg .= &mt('Current standard notification e-mail - [_1] for [_2] is different to e-mail address in institutional classlist - [_3].', + $userenv{notification},$uname,$emailenc). + $linefeed; + } + } + if ($userenv{permanentemail} =~ m/%40/) { + unless ($emailenc eq $userenv{permanentemail}) { + $$logmsg .= &mt('Current permanent e-mail +- [_1] for [_2] is different to e-mail address in institutional classlist - [_3]',$userenv{permanentemail},$uname,$emailenc).$linefeed; } } my $krbdefdom = ''; @@ -590,14 +717,14 @@ sub execute_add { } elsif ($currentauth=~ /^(unix|internal|localauth):/) { $currentauth = $1; } else { - $$logmsg .= "Invalid authentication method $currentauth for $uname.".$linefeed; + $$logmsg .= &mt('Invalid authentication method [_1] for [_2].',$currentauth,$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; + $$logmsg .= &mt("Authentication type mismatch for [_1] - '[_2]' in system, '[_3]' based on information in classlist or default for this course.",$uname,$currentauth,$auth).$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; + $$logmsg .= &mt("Kerberos domain mismatch for [_1] - '[_2]' in system, '[_3]' based on information in classlist or default for this course.",$uname,$krbdefdom,$authparam).$linefeed; } } @@ -606,7 +733,8 @@ sub execute_add { $middle ne $userenv{'middlename'} || $last ne $userenv{'lastname'} || $gene ne $userenv{'generation'} || - $pid ne $userenv{'id'} ) { + $pid ne $userenv{'id'} || + $emailenc ne $userenv{'permanentemail'} ) { # Make the change(s) my %changeHash; $changeHash{'firstname'} = $first; @@ -614,29 +742,38 @@ sub execute_add { $changeHash{'lastname'} = $last; $changeHash{'generation'} = $gene; $changeHash{'id'} = $pid; + $changeHash{'permanentemail'} = $emailenc; my $putresult = &Apache::lonnet::put('environment',\%changeHash,$dom,$uname); if ($putresult eq 'ok') { - $$logmsg .= "User information updated for user: $uname prior to enrollment.".$linefeed; + $$logmsg .= &mt('User information updated for user: [_1] prior to enrollment.',$uname).$linefeed; } else { - $$logmsg .= "There was a problem modifying user data for existing user - $uname -error: $putresult, enrollment will still be attempted.".$linefeed; + $$logmsg .= &mt('There was a problem modifying user data for existing user - [_1] -error: [_2], enrollment will still be attempted.',$uname,$putresult).$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); + my $classlist_reply = + &Apache::lonnet::modify_student_enrollment($dom,$uname,$pid,$first,$middle, + $last,$gene,$usec,$end,$start, + 'auto','',$cid,'',$context, + $credits); if ($classlist_reply eq 'ok') { my $access = &showaccess($end,$start); + my $showsec = $usec; + if ($usec eq '') { + $showsec = &mt('none'); + } if ($caller eq 'switchtype') { - $$logmsg .= "Existing user $uname detected in institutional classlist - switched from 'manual' to 'auto' enrollment in section/group $usec.".$access.$linefeed; + $$logmsg .= &mt("Existing user [_1] detected in institutional classlist - switched from 'manual' to 'auto' enrollment in section [_2].",$uname,$showsec).$access.$linefeed; } elsif ($caller eq 'newstudent') { $$enrollcount ++; - $$addresult .= "$first $last ($pid) - $uname enrolled in section/group $usec.".$access.$linefeed; + $$addresult .= "$first $last ($pid) - $uname ".&mt("enrolled in section '[_1]'.",$showsec).$access.$linefeed; } if ($context eq 'automated') { - $$logmsg .= "Existing $dom user $uname enrolled successfully.".$linefeed; + $$logmsg .= &mt('Existing [_1] user [_2] enrolled successfully.',$dom,$uname).$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; + $$logmsg .= &mt('There was a problem updating the classlist db file for user [_1] to show the new enrollment -error: [_2], so no enrollment occurred for this user.',$uname,$classlist_reply).$linefeed; } return; } @@ -673,7 +810,7 @@ sub showaccess { } else { $showend = &Apache::lonlocal::locallocaltime($end); } - my $access_msg = " Access starts: ".$showstart.", ends: ".$showend."."; + my $access_msg = ' '.&mt('Access starts: [_1], ends: [_2].',$showstart,$showend); return $access_msg; } @@ -682,7 +819,7 @@ sub parse_classlist { my $xmlfile = $tmpdir."/tmp/".$dom."_".$crs."_".$class."_classlist.xml"; my $uname = ''; my @state; - my @items = ('autharg','authtype','email','firstname','generation','lastname','middlename','studentID'); + my @items = ('autharg','authtype','email','firstname','generation','lastname','middlename','studentID','credits','inststatus'); my $p = HTML::Parser->new ( xml_mode => 1, @@ -692,14 +829,13 @@ sub parse_classlist { push @state, $tagname; if ("@state" eq "students student") { $uname = $attr->{username}; + $$studentsref{$uname}[ $$placeref{'groupID'} ] = $groupID; } }, "tagname, attr"], text_h => [sub { my ($text) = @_; - if ("@state" eq "students student groupID") { - $$studentsref{$uname}[ $$placeref{'groupID'} ] = $groupID; - } elsif ("@state" eq "students student startdate") { + if ("@state" eq "students student startdate") { my $start = $text; unless ($text eq '') { $start = &process_date($text); @@ -770,70 +906,58 @@ sub create_password { 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 get_courseinfo { my ($dom,$crs,$courseinfo) = @_; my $owner; if (defined($dom) && defined($crs)) { - my %settings = &Apache::lonnet::get('environment',['internal.coursecode','description'],$dom,$crs); + my %settings = &Apache::lonnet::get('environment',['internal.coursecode','internal.showphoto','description','internal.defaultcredits'],$dom,$crs); if ( defined($settings{'internal.coursecode'}) ) { $$courseinfo{'inst_code'} = $settings{'internal.coursecode'}; - } if ( defined($settings{'description'}) ) { $$courseinfo{'description'} = $settings{'description'}; } + if ( defined($settings{'internal.showphoto'}) ) { + $$courseinfo{'showphoto'} = $settings{'internal.showphoto'}; + } + if ( defined($settings{'internal.credithours'}) ) { + $$courseinfo{'defaultcredits'} = $settings{'internal.defaultcredits'}; + } } return; } -sub CL_autharg { return 0; } -sub CL_authtype { return 1;} -sub CL_email { return 2;} -sub CL_enddate { return 3;} -sub CL_firstname { return 4;} -sub CL_generation { return 5;} -sub CL_groupID { return 6;} -sub CL_lastname { return 7;} -sub CL_middlename { return 8;} -sub CL_startdate { return 9; } -sub CL_studentID { return 10; } +sub place_hash { + my %place = ( + autharg => 0, + authtype => 1, + email => 2, + enddate => 3, + firstname => 4, + generation => 5, + groupID => 6, + lastname => 7, + middlename => 8, + startdate => 9, + studentID => 10, + credits => 11, + inststatus => 12, + ); + return %place; +} + +sub photo_response_types { + my %lt = &Apache::lonlocal::texthash( + 'same' => 'remained unchanged', + 'update' => 'were updated', + 'new' => 'were added', + 'missing' => 'were missing', + 'error' => 'were not imported because an error occurred', + 'nouser' => 'were for users without accounts', + 'noid' => 'were for users without student/employee IDs', + ); + return %lt; +} + 1;