# The LearningOnline Network with CAPA # Handler to drop and add students in courses # # $Id: londropadd.pm,v 1.31 2002/04/26 18:59:00 matthew 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/ # # (Handler to set parameters for assessments # # (Handler to resolve ambiguous file locations # # (TeX Content Handler # # YEAR=2000 # 05/29/00,05/30,10/11 Gerd Kortemeyer) # # 10/11,10/12,10/16 Gerd Kortemeyer) # # 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28, # 12/08,12/12 Gerd Kortemeyer) # # 12/26,12/27,12/28, # YEAR=2001 # 01/01/01,01/15,02/10,02/13,02/14,02/22 Gerd Kortemeyer # 8/6 Scott Harrison # Guy Albertelli # 9/25 Gerd Kortemeyer # 12/19 Guy Albertelli # YEAR=2002 # 1/4 Gerd Kortemeyer package Apache::londropadd; use strict; use Apache::lonnet(); use Apache::loncommon(); use Apache::Constants qw(:common :http REDIRECT); # ================================================================ Print header sub header { return(< LON-CAPA Student Drop/Add

Drop/Add Students

Course: $ENV{'course.'.$ENV{'request.course.id'}.'.description'}

ENDHEAD } # =========== Drop student from all sections of a course, except optional $csec sub modifystudent { my ($udom,$unam,$courseid,$csec)=@_; # if $csec is undefined, drop the student from all the courses matching # this one. If $csec is defined, drop them from all other sections of # this course and add them to section $csec $courseid=~s/\_/\//g; $courseid=~s/^(\w)/\/$1/; my %roles = &Apache::lonnet::dump('roles',$udom,$unam); my ($tmp) = keys(%roles); # Bail out if we were unable to get the students roles return if ($tmp =~ /^(con_lost|error|no_such_host)/i); # Go through the roles looking for enrollment in this course foreach my $course (keys(%roles)) { my $value = $roles{$course}; if ($course=~/^$courseid(?:\/)*(\w+)*\_st$/) { # We are in this course my $section=$1; $section='' if ($course eq $courseid.'_st'); if (((!$section) && (!$csec)) || ($section ne $csec)) { my (undef,$end,$start)=split(/\_/,$roles{$course}); my $now=time; if (!($start && ($now<$start)) || !($end && ($now>$end))) { my $reply=&Apache::lonnet::modifystudent ($udom,$unam,'','','','','','','',$section,time); } } } } } # ============ build a domain and server selection form sub domain_form { my ($defdom) = @_; # Set up domain and server selection forms # # Get the domains my @domains = &Apache::loncommon::get_domains(); # build up the menu information to be passed to # &Apache::loncommon::linked_select_forms my %select_menus; foreach my $dom (@domains) { # set up the text for this domain $select_menus{$dom}->{'text'}= $dom; # we want a choice of 'default' as the default in the second menu $select_menus{$dom}->{'default'}= 'default'; $select_menus{$dom}->{'select2'}->{'default'} = 'default'; # Now build up the other items in the second menu my %servers = &Apache::loncommon::get_home_servers($dom); foreach my $server (keys(%servers)) { $select_menus{$dom}->{'select2'}->{$server} = "$server $servers{$server}"; } } my $result = &Apache::loncommon::linked_select_forms ('studentform',' with home server ',$defdom, 'lcdomain','lcserver',\%select_menus); return $result; } # ============================================================== Menu Phase One sub menu_phase_one { my $r=shift; my $upfile_select=&Apache::loncommon::upfile_select_html(); $r->print(<

Upload a courselist

$upfile_select

Enroll a single student

Drop students

ENDUPFORM } sub phase_two_header { my ($r,$datatoken,$distotal,$krbdefdom)=@_; my $javascript; if ($ENV{'form.upfile_associate'} eq 'reverse') { $javascript=&phase_two_javascript_reverse_associate(); } else { $javascript=&phase_two_javascript_forward_associate(); } my $javascript_validations=&javascript_validations($krbdefdom); $r->print(<

Identify fields

Total number of records found in file: $distotal
Enter as many fields as you can. The system will inform you and bring you back to this page if the data selected is insufficient to run your class.
ENDPICK } sub javascript_validations { my ($krbdefdom)=@_; my %param = ( formname => 'studentform', kerb_def_dom => $krbdefdom ); my $authheader = &Apache::loncommon::authform_header(%param); return (<=2) && (tw<=6)) { foundname=1; } if (tw==7) { foundid=1; } if (tw==8) { foundsec=1; } if (tw==9) { foundpwd=1; } } verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec); } function flip(vf,tf) { var nw=eval('vf.f'+tf+'.selectedIndex'); var i; for (i=0;i<=vf.nfields.value;i++) { if ((i!=tf) && (eval('vf.f'+i+'.selectedIndex')==nw)) { eval('vf.f'+i+'.selectedIndex=0;') } } if (tf==1 && nw!=0) { for (i=2;i<=5;i++) { eval('vf.f'+i+'.selectedIndex=0;') } } if (nw==2) { for (i=0;i<=vf.nfields.value;i++) { if ((eval('vf.f'+i+'.selectedIndex')>=3) && (eval('vf.f'+i+'.selectedIndex')<=6)) { eval('vf.f'+i+'.selectedIndex=0;') } } } if ((nw>=3) && (nw<=6)) { for (i=0;i<=vf.nfields.value;i++) { if (eval('vf.f'+i+'.selectedIndex')==2) { eval('vf.f'+i+'.selectedIndex=0;') } } } if (nw==9) { changed_radio('int',document.studentform); set_auth_radio_buttons('int',document.studentform); vf.intarg.value=''; vf.krbarg.value=''; vf.locarg.value=''; } } function clearpwd(vf) { var i; for (i=0;i<=vf.nfields.value;i++) { if (eval('vf.f'+i+'.selectedIndex')==9) { eval('vf.f'+i+'.selectedIndex=0;') } } } ENDPICK } sub phase_two_javascript_reverse_associate { return(<=1) && (i<=5)) && tw!=0 ) { foundname=1; } if (i==6 && tw!=0) { foundid=1; } if (i==7 && tw!=0) { foundsec=1; } if (i==8 && tw!=0) { foundpwd=1; } } verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec); } function flip(vf,tf) { var nw=eval('vf.f'+tf+'.selectedIndex'); var i; // picked the all one one name field, reset the other name ones to blank if (tf==1 && nw!=0) { for (i=2;i<=5;i++) { eval('vf.f'+i+'.selectedIndex=0;') } } //picked one of the piecewise name fields, reset the all in //one field to blank if ((tf>=2) && (tf<=5) && (nw!=0)) { eval('vf.f1.selectedIndex=0;') } // intial password specified, pick internal authentication if (tf==8 && nw!=0) { changed_radio('int',document.studentform); set_auth_radio_buttons('int',document.studentform); vf.krbarg.value=''; vf.intarg.value=''; vf.locarg.value=''; } } function clearpwd(vf) { var i; if (eval('vf.f8.selectedIndex')!=0) { eval('vf.f8.selectedIndex=0;') } } ENDPICK } sub phase_two_end { my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_; my %param = ( formname => 'document.studentform'); my $krbform = &Apache::loncommon::authform_kerberos(%param); my $intform = &Apache::loncommon::authform_internal(%param); my $locform = &Apache::loncommon::authform_local(%param); my $domform = &domain_form($defdom); $r->print(<

Login Type

Note: this will not take effect if the user already exists

$krbform

$intform

$locform

LON-CAPA Domain for Students

LON-CAPA domain: $domform

Starting and Ending Dates

Set Starting Date

Set Ending Date

Full Update

Full update (also print list of users not enrolled anymore)

ID/Student Number

Disable ID/Student Number Safeguard and Force Change of Conflicting IDs (only do if you know what you are doing)


Note: for large courses, this operation might be time consuming. ENDPICK } # ======================================================= Menu Phase Two Upload sub menu_phase_two_upload { my $r=shift; my $datatoken; if (!$ENV{'form.datatoken'}) { $datatoken=&Apache::loncommon::upfile_store($r); } else { $datatoken=$ENV{'form.datatoken'}; &Apache::loncommon::load_tmp_file($r); } my @records=&Apache::loncommon::upfile_record_sep(); my $total=$#records; my $distotal=$total+1; $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; my $krbdefdom=$1; $krbdefdom=~tr/a-z/A-Z/; my $today=time; my $halfyear=$today+15552000; my $defdom=$r->dir_config('lonDefDomain'); &phase_two_header($r,$datatoken,$distotal,$krbdefdom); my $i; my $keyfields; if ($total>=0) { my @d=(['username','Username'],['names','Last Name, First Names'], ['fname','First Name'],['mname','Middle Names/Initials'], ['lname','Last Name'],['gen','Generation'], ['id','ID/Student Number'],['sec','Group/Section'], ['ipwd','Initial Password']); if ($ENV{'form.upfile_associate'} eq 'reverse') { &Apache::loncommon::csv_print_samples($r,\@records); $i=&Apache::loncommon::csv_print_select_table($r,\@records,\@d); foreach (@d) { $keyfields.=$_->[0].','; } chop($keyfields); } else { unshift(@d,['none','']); $i=&Apache::loncommon::csv_samples_select_table($r,\@records,\@d); my %sone=&Apache::loncommon::record_sep($records[0]); $keyfields=join(',',sort(keys(%sone))); } } &phase_two_end($r,$i,$keyfields,$defdom,$today,$halfyear); } # ======================================================= Enroll single student sub enroll_single_student { my $r=shift; $r->print('

Enrolling Student

'); $r->print($ENV{'form.cuname'}." in domain ".$ENV{'form.lcdomain'}); if (($ENV{'form.cuname'})&&($ENV{'form.cuname'}!~/\W/)&& ($ENV{'form.lcdomain'})&&($ENV{'form.lcdomain'}!~/\W/)) { # Deal with home server selection my $domain=$ENV{'form.lcdomain'}; my $desiredhost = $ENV{'form.lcserver'}; if (lc($desiredhost) eq 'default') { $desiredhost = undef; } else { my %home_servers = &Apache::loncommon::get_home_servers($domain); if (! exists($home_servers{$desiredhost})) { $r->print('Error:'. 'Invalid home server specified'); return; } } $r->print(" with server $desiredhost :"); # End of home server selection logic my $amode=''; my $genpwd=''; if ($ENV{'form.login'} eq 'krb') { $amode='krb4'; $genpwd=$ENV{'form.krbarg'}; } elsif ($ENV{'form.login'} eq 'int') { $amode='internal'; $genpwd=$ENV{'form.intarg'}; } elsif ($ENV{'form.login'} eq 'loc') { $amode='localauth'; $genpwd=$ENV{'form.locarg'}; if (!$genpwd) { $genpwd=" "; } } if (($amode) && ($genpwd)) { $r->print(&Apache::lonnet::modifystudent( $ENV{'form.lcdomain'},$ENV{'form.cuname'}, $ENV{'form.cstid'},$amode,$genpwd, $ENV{'form.cfirst'},$ENV{'form.cmiddle'}, $ENV{'form.clast'},$ENV{'form.cgen'}, $ENV{'form.csec'},$ENV{'form.enddate'}, $ENV{'form.startdate'},$ENV{'form.forceid'}, $desiredhost)); &modifystudent($ENV{'form.lcdomain'},$ENV{'form.cuname'}, $ENV{'request.course.id'},$ENV{'form.csec'}); } else { $r->print('Invalid login mode or password'); } } else { $r->print('Invalid username or domain'); } } # ======================================================= Menu Phase Two Enroll sub menu_phase_two_enroll { my $r=shift; my ($krbdefdom) = $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; $krbdefdom=~tr/a-z/A-Z/; my $today = time; my $halfyear = $today+15552000; my $defdom=$r->dir_config('lonDefDomain'); my $javascript_validations=&javascript_validations($krbdefdom); # Set up authentication forms my %param = ( formname => 'document.studentform'); my $krbform = &Apache::loncommon::authform_kerberos(%param); my $intform = &Apache::loncommon::authform_internal(%param); my $locform = &Apache::loncommon::authform_local(%param); # Set up domain selection form my $domform = &domain_form($defdom); # Print it all out $r->print(< function verify(vf) { var founduname=0; var foundpwd=0; var foundname=0; var foundid=0; var foundsec=0; var tw; if ((typeof(vf.cuname.value) !="undefined") && (vf.cuname.value!='') && (typeof(vf.lcdomain.value)!="undefined") && (vf.lcdomain.value!='')) { founduname=1; } if ((typeof(vf.cfirst.value)!="undefined") && (vf.cfirst.value!='') && (typeof(vf.clast.value) !="undefined") && (vf.clast.value!='')) { foundname=1; } if ((typeof(vf.csec.value)!="undefined") && (vf.csec.value!='')) { foundsec=1; } if ((typeof(vf.cstid.value)!="undefined") && (vf.cstid.value!='')) { foundid=1; } if (founduname==0) { alert('You need to specify at least the username and domain fields'); return; } verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec); } $javascript_validations function clearpwd(vf) { //nothing else needs clearing }

Personal Data

First Name:
Middle Name:
Last Name:
Generation:

ID/Student Number:

Group/Section:

Login Data

Username:

Domain: $domform

Note: login settings below will not take effect if the user already exists

$krbform

$intform

$locform

Starting and Ending Dates

Set Starting Date

Set Ending Date

ID/Student Number

Disable ID/Student Number Safeguard and Force Change of Conflicting IDs (only do if you know what you are doing)


ENDSENROLL } # =================================================== get the current classlist sub get_current_classlist { my ($domain,$identifier) = @_; # domain is the domain the class is being run in # identifier is the internal, unique identifier for the class. my %currentlist=(); my $now=time; my %results=&Apache::lonnet::dump('classlist',$domain,$identifier); my ($tmp) = keys(%results); if ($tmp !~ /^(con_lost|error|no_such_host)/i) { foreach my $student (keys(%results)) { # Extract the start and end dates my ($end,$start)=split(/\:/,$results{$student}); # If the class isn't over, put it in the list unless (($end) && ($now>$end)) { $currentlist{$student}=1; } } return (undef,%currentlist); } else { return ($tmp,undef); } } # ========================================================= Menu Phase Two Drop sub menu_phase_two_drop { my $r=shift; my $cid=$ENV{'request.course.id'}; my ($error,%currentlist)=&get_current_classlist($ENV{'course.'.$cid.'.domain'}, $ENV{'course.'.$cid.'.num'}); if (defined($error)) { $r->print('
ERROR:$error
'); } if (!defined(%currentlist)) { $r->print("There are no students currently enrolled.\n"); } else { # Print out the available choices &show_drop_list($r,%currentlist); } } # =================================================== Show student list to drop sub show_drop_list { my ($r,%currentlist)=@_; my $cid=$ENV{'request.course.id'}; $r->print(<<'END'); END foreach (sort keys %currentlist) { my ($sname,$sdom)=split(/\:/,$_); my %reply=&Apache::lonnet::idrget($sdom,$sname); my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid); my %info=&Apache::lonnet::get('environment', ['firstname','middlename', 'lastname','generation'], $sdom, $sname); my ($tmp) = keys(%info); if ($tmp =~ /^(con_lost|error|no_such_host)/i) { $r->print(''); } else { $r->print(<<"END"); END } } $r->print('
 usernamedomain IDstudent namegeneration section
'. 'Internal error: unable to get environment '. 'for '.$sname.' in domain '.$sdom.'
$sname $sdom $reply{$sname} $info{'lastname'}, $info{'firstname'} $info{'middlename'} $info{'generation'} $ssec

'); $r->print(''); } # ================================================= Drop/Add from uploaded file sub upfile_drop_add { my $r=shift; &Apache::loncommon::load_tmp_file($r); my @studentdata=&Apache::loncommon::upfile_record_sep(); my @keyfields = split(/\,/,$ENV{'form.keyfields'}); my $cid = $ENV{'request.course.id'}; my %fields=(); for (my $i=0; $i<=$ENV{'form.nfields'}; $i++) { if ($ENV{'form.upfile_associate'} eq 'reverse') { if ($ENV{'form.f'.$i} ne 'none') { $fields{$keyfields[$i]}=$ENV{'form.f'.$i}; } } else { $fields{$ENV{'form.f'.$i}}=$keyfields[$i]; } } # my $startdate = $ENV{'form.startdate'}; my $enddate = $ENV{'form.enddate'}; if ($startdate=~/\D/) { $startdate=''; } if ($enddate=~/\D/) { $enddate=''; } # Determine domain and desired host (home server) my $domain=$ENV{'form.lcdomain'}; my $desiredhost = $ENV{'form.lcserver'}; if (lc($desiredhost) eq 'default') { $desiredhost = undef; } else { my %home_servers = &Apache::loncommon::get_home_servers($domain); if (! exists($home_servers{$desiredhost})) { $r->print('Error:'. 'Invalid home server specified'); return; } } # Determine authentication mechanism my $amode = ''; my $genpwd = ''; if ($ENV{'form.login'} eq 'krb') { $amode='krb4'; $genpwd=$ENV{'form.krbarg'}; } elsif ($ENV{'form.login'} eq 'int') { $amode='internal'; if ((defined($ENV{'form.intarg'})) && ($ENV{'form.intarg'})) { $genpwd=$ENV{'form.intarg'}; } } elsif ($ENV{'form.login'} eq 'loc') { $amode='localauth'; if ((defined($ENV{'form.locarg'})) && ($ENV{'form.locarg'})) { $genpwd=$ENV{'form.locarg'}; } } unless (($domain=~/\W/) || ($amode eq '')) { ####################################### ## Enroll Students ## ####################################### $r->print('

Enrolling Students

'); my $count=0; my $flushc=0; my %student=(); # Get new classlist foreach (@studentdata) { my %entries=&Apache::loncommon::record_sep($_); # Determine student name unless (($entries{$fields{'username'}} eq '') || (!defined($entries{$fields{'username'}}))) { my ($fname, $mname, $lname,$gen) = ('','','',''); if (defined($fields{'names'})) { ($lname,$fname,$mname)=($entries{$fields{'names'}}=~ /([^\,]+)\,\s*(\w+)\s*(.*)$/); } else { if (defined($fields{'fname'})) { $fname=$entries{$fields{'fname'}}; } if (defined($fields{'mname'})) { $mname=$entries{$fields{'mname'}}; } if (defined($fields{'lname'})) { $lname=$entries{$fields{'lname'}}; } if (defined($fields{'gen'})) { $gen=$entries{$fields{'gen'}}; } } if ($entries{$fields{'username'}}=~/\W/) { $r->print('

Unacceptable username: '. $entries{$fields{'username'}}.' for user '. $fname.' '.$mname.' '.$lname.' '.$gen.'

'); } else { # determine section number my $sec=''; my $username=$entries{$fields{'username'}}; if (defined($fields{'sec'})) { if (defined($entries{$fields{'sec'}})) { $sec=$entries{$fields{'sec'}}; } } # determine student id number my $id=''; if (defined($fields{'id'})) { if (defined($entries{$fields{'id'}})) { $id=$entries{$fields{'id'}}; } $id=~tr/A-Z/a-z/; } # determine student password my $password=''; if ($genpwd) { $password=$genpwd; } else { if (defined($fields{'ipwd'})) { if ($entries{$fields{'ipwd'}}) { $password=$entries{$fields{'ipwd'}}; } } } if ($password) { my $reply=&Apache::lonnet::modifystudent ($domain,$username,$id,$amode,$password, $fname,$mname,$lname,$gen,$sec,$enddate, $startdate,$ENV{'form.forceid'},$desiredhost); &modifystudent($domain,$username,$cid,$sec); if ($reply ne 'ok') { $r->print('

'. 'Error enrolling '.$username.': '. $reply.'

'); } else { $count++; $flushc++; $student{$username}=1; $r->print('. '); if ($flushc>15) { $r->rflush; $flushc=0; } } } else { $r->print("

No password for $username

"); } } } } # end of foreach (@studentdata) $r->print('

Processed Students: '.$count); ##################################### # Drop students # ##################################### if ($ENV{'form.fullup'} eq 'yes') { $r->print('

Dropping Students

'); # Get current classlist my ($error,%currentlist)=&get_current_classlist ($ENV{'course.'.$cid.'.domain'}, $ENV{'course.'.$cid.'.num'}); if (defined($error)) { $r->print('
ERROR:$error
'); } if (defined(%currentlist)) { # Drop the students foreach (@studentdata) { my %entries=&Apache::loncommon::record_sep($_); unless (($entries{$fields{'username'}} eq '') || (!defined($entries{$fields{'username'}}))) { delete($currentlist{$entries{$fields{'username'}}. ':'.$domain}); } } # Print out list of dropped students &show_drop_list($r,%currentlist); } else { $r->print("There are no students currently enrolled.\n"); } } } # end of unless } # ================================================================== Phase four sub drop_student_list { my $r=shift; my $count=0; foreach (@{$ENV{'form.droplist'}}) { my ($uname,$udom)=split(/\:/,$_); &modifystudent($udom,$uname,$ENV{'request.course.id'}); $r->print('Dropped '.$uname.' at '.$udom.'
'); $count++; } $r->print('

Dropped '.$count.' student(s).'); $r->print('

Re-enrollment will re-activate data.'); } # ================================================================ Main Handler sub handler { my $r=shift; if ($r->header_only) { $r->content_type('text/html'); $r->send_http_header; return OK; } # Needs to be in a course if (($ENV{'request.course.fn'}) && (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'}))) { # Start page $r->content_type('text/html'); $r->send_http_header; $r->print(&header()); # Phase one, initial screen unless ($ENV{'form.phase'}) { &menu_phase_one($r); } # Phase two if ($ENV{'form.associate'} eq 'Reverse Association') { $ENV{'form.phase'} = 'two'; if ( $ENV{'form.upfile_associate'} ne 'reverse' ) { $ENV{'form.upfile_associate'} = 'reverse'; } else { $ENV{'form.upfile_associate'} = 'forward'; } } if ($ENV{'form.phase'} eq 'two') { if ($ENV{'form.fileupload'}) { &menu_phase_two_upload($r); } elsif ($ENV{'form.enroll'}) { &menu_phase_two_enroll($r); } elsif ($ENV{'form.drop'}) { &menu_phase_two_drop($r); } } # Phase three if ($ENV{'form.phase'} eq 'three') { if ($ENV{'form.datatoken'}) { &upfile_drop_add($r); } } # Phase four if ($ENV{'form.phase'} eq 'four') { &drop_student_list($r); } # Phase five if ($ENV{'form.phase'} eq 'five') { &enroll_single_student($r); } # End $r->print('

'); } else { # Not in a course, or not allowed to modify parms $ENV{'user.error.msg'}= "/adm/dropadd:cst:0:0:Cannot drop or add students"; return HTTP_NOT_ACCEPTABLE; } return OK; } 1; __END__