--- loncom/interface/Attic/londropadd.pm 2002/04/04 20:41:17 1.23 +++ loncom/interface/Attic/londropadd.pm 2003/07/21 17:54:43 1.76 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# $Id: londropadd.pm,v 1.23 2002/04/04 20:41:17 albertel Exp $ +# $Id: londropadd.pm,v 1.76 2003/07/21 17:54:43 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -31,315 +31,359 @@ # # (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::lonnet(); +use Apache::loncommon(); +use Apache::lonhtmlcommon(); use Apache::Constants qw(:common :http REDIRECT); +use Spreadsheet::WriteExcel; -# ================================================================ Print header - +############################################################### +############################################################### sub header { - my $r=shift; - $r->print(< -LON-CAPA Student Drop/Add +LON-CAPA Enrollment Manager - - -

Drop/Add Students

-
-

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

+$bodytag + ENDHEAD } -# ========================================================= Store uploaded file -# needs $ENV{'form.upfile'} -# return $datatoken to be put into hidden field - -sub upfile_store { - my $r=shift; - $ENV{'form.upfile'}=~s/\r/\n/gs; - $ENV{'form.upfile'}=~s/\f/\n/gs; - $ENV{'form.upfile'}=~s/\n+/\n/gs; - $ENV{'form.upfile'}=~s/\n+$//gs; - - my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}. - '_enroll_'.$ENV{'request.course.id'}.'_'.time.'_'.$$; - { - my $fh=Apache::File->new('>'.$r->dir_config('lonDaemons'). - '/tmp/'.$datatoken.'.tmp'); - print $fh $ENV{'form.upfile'}; - } - return $datatoken; -} - -# ================================================= Load uploaded file from tmp -# needs $ENV{'form.datatoken'} -# sets $ENV{'form.upfile'} - -sub load_tmp_file { - my $r=shift; - my @studentdata=(); - { - my $fh; - if ($fh=Apache::File->new($r->dir_config('lonDaemons'). - '/tmp/'.$ENV{'form.datatoken'}.'.tmp')) { - @studentdata=<$fh>; - } - } - $ENV{'form.upfile'}=join('',@studentdata); -} - -# ========================================= Separate uploaded file into records -# returns array of records - -sub upfile_record_sep { - if ($ENV{'form.upfiletype'} eq 'xml') { - } else { - return split(/\n/,$ENV{'form.upfile'}); - } -} - -# =============================================== Separate a record into fields - -sub record_sep { - my $record=shift; - my %components=(); - if ($ENV{'form.upfiletype'} eq 'xml') { - } elsif ($ENV{'form.upfiletype'} eq 'space') { - my $i=0; - foreach (split(/\s+/,$record)) { - my $field=$_; - $field=~s/^(\"|\')//; - $field=~s/(\"|\')$//; - $components{$i}=$field; - $i++; - } - } elsif ($ENV{'form.upfiletype'} eq 'tab') { - my $i=0; - foreach (split(/\t+/,$record)) { - my $field=$_; - $field=~s/^(\"|\')//; - $field=~s/(\"|\')$//; - $components{$i}=$field; - $i++; - } - } else { - my @allfields=split(/\,/,$record); - my $i=0; - my $j; - for ($j=0;$j<=$#allfields;$j++) { - my $field=$allfields[$j]; - if ($field=~/^\s*(\"|\')/) { - my $delimiter=$1; - while (($field!~/$delimiter$/) && ($j<$#allfields)) { - $j++; - $field.=','.$allfields[$j]; - } - $field=~s/^\s*$delimiter//; - $field=~s/$delimiter\s*$//; +############################################################### +############################################################### +# Drop student from all sections of a course, except optional $csec +sub modifystudent { + my ($udom,$unam,$courseid,$csec,$desiredhost)=@_; + # 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 "$1" if ($tmp =~ /^(con_lost|error|no_such_host)/i); + # Go through the roles looking for enrollment in this course + my $result = ''; + foreach my $course (keys(%roles)) { + if ($course=~/^$courseid(?:\/)*(?:\s+)*(\w+)*\_st$/) { + # We are in this course + my $section=$1; + $section='' if ($course eq $courseid.'_st'); + if ($section eq $csec) { + $result .= 'ok:'; + } elsif ( ((!$section) && (!$csec)) || ($section ne $csec) ) { + my (undef,$end,$start)=split(/\_/,$roles{$course}); + my $now=time; + # if this is an active role + if (!($start && ($now<$start)) || !($end && ($now>$end))) { + my $reply=&Apache::lonnet::modifystudent + # dom name id mode pass f m l g + ($udom,$unam,'', '', '',undef,undef,undef,undef, + $section,time,undef,undef,$desiredhost); + $result .= $reply.':'; + } } - $components{$i}=$field; - $i++; } } - return %components; + if ($result eq '') { + $result = 'Unable to find section for this student'; + } else { + $result =~ s/(ok:)+/ok/g; + } + return $result; } -# =========== Drop student from all sections of a course, except optional $csec - -sub dropstudent { - my ($udom,$unam,$courseid,$csec)=@_; - $courseid=~s/\_/\//g; - $courseid=~s/^(\w)/\/$1/; - foreach (split(/\&/, - &Apache::lonnet::reply('dump:'.$udom.':'.$unam.':roles', - &Apache::lonnet::homeserver($unam,$udom)))) { - my ($key,$value)=split(/\=/,$_); - $key=&Apache::lonnet::unescape($key); - if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) { - my $section=$1; - if ($key eq $courseid.'_st') { $section=''; } - if (((!$section) && (!$csec)) || ($section ne $csec)) { - my ($dummy,$end,$start)=split(/\_/, - &Apache::lonnet::unescape($value)); - my $now=time; - my $notactive=0; - if ($start) { - if ($now<$start) { $notactive=1; } - } - if ($end) { - if ($now>$end) { $notactive=1; } - } - unless ($notactive) { - 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_library_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 { +############################################################### +############################################################### +# Menu Phase One +sub print_main_menu { my $r=shift; - $r->print(< -
-

Upload a courselist

- -
Type: -

-

-

Enroll a single student

-

-

-

Drop students

-

-ENDUPFORM + $r->print(< + + Upload a course list + +

+ + Enroll a single student + +

+ + Modify student data + +

+ + View Class List + +

+ + Drop Students + +

+END } - -sub phase_two_header { +############################################################### +############################################################### +sub print_upload_manager_header { my ($r,$datatoken,$distotal,$krbdefdom)=@_; + my $javascript; + if (! exists($ENV{'form.upfile_associate'})) { + $ENV{'form.upfile_associate'} = 'forward'; + } + if ($ENV{'form.associate'} eq 'Reverse Association') { + if ( $ENV{'form.upfile_associate'} ne 'reverse' ) { + $ENV{'form.upfile_associate'} = 'reverse'; + } else { + $ENV{'form.upfile_associate'} = 'forward'; + } + } + if ($ENV{'form.upfile_associate'} eq 'reverse') { + $javascript=&upload_manager_javascript_reverse_associate(); + } else { + $javascript=&upload_manager_javascript_forward_associate(); + } + my $javascript_validations=&javascript_validations($krbdefdom); $r->print(< - - +

Uploading Class List

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); + my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition(); + return (<=2) && (tw<=6)) { foundname=1; } - if (tw==7) { foundid=1; } - if (tw==8) { foundsec=1; } - if (tw==9) { foundpwd=1; } - } if (founduname==0) { - alert('You need to specify at least the username field'); + alert('You need to specify the username field'); return; } - if (vf.login[0].checked) { - foundatype=1; - if (vf.krbdom.value=='') { - alert('You need to specify the Kerberos domain'); - return; - } + // alert('current.radiovalue = '+current.radiovalue); + if (current.radiovalue == null || current.radiovalue == 'nochange') { + // They did not check any of the login radiobuttons. + alert('You must choose an authentication type'); + return; } - if (vf.login[1].checked) { - foundatype=1; - if ((vf.intpwd.value=='') && (foundpwd==0)) { - alert('You need to specify the initial password'); + foundatype=1; + if (current.argfield == null || current.argfield == '') { + var alertmsg = ''; + switch (current.value) { + case 'krb': + alertmsg = 'You need to specify the Kerberos domain'; + break; + case 'loc': + case 'fsys': + alertmsg = 'You need to specify the initial password'; + break; + case 'fsys': + alertmsg = ''; + break; + default: + alertmsg = ''; + } + if (alertmsg != '') { + alert(alertmsg); return; } } - if (vf.login[2].checked) { - foundatype=1; - //An argument is not required + + if (foundname==0) { message='name fields'; } + if (foundid==0) { if (message!='') { message+=', '; } message+='student number field'; } + if (foundsec==0) { if (message!='') { message+=', '; } message+='section or group field'; } + if (foundemail==0) { if (message!='') { message+=', '; } message+='email address field'; } + if (message!='') { + message='Not specified (optional): '+message+'. Continue enrollment?'; + if (confirm(message)) { + vf.state.value='enrolling'; + vf.submit(); + } + } else { + vf.state.value='enrolling'; + vf.submit(); } - if (foundatype==0) { - alert('You need to set the login type'); +} + +$authheader +ENDPICK + +} + +sub javascript_validations_without_auth { + my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition(); + return (<=2) && (tw<=6)) { foundname=1; } + if (tw==7) { foundid=1; } + if (tw==8) { foundsec=1; } + if (tw==9) { foundpwd=1; } + if (tw==10) { foundemail=1; } + } + verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec,foundemail); } +// +// vf = this.form +// tf = column number +// +// values of nw +// +// 0 = none +// 1 = username +// 2 = names (lastname, firstnames) +// 3 = fname (firstname) +// 4 = mname (middlename) +// 5 = lname (lastname) +// 6 = gen (generation) +// 7 = id +// 8 = section +// 9 = ipwd (password) +// 10 = email address + function flip(vf,tf) { var nw=eval('vf.f'+tf+'.selectedIndex'); var i; + // make sure no other columns are labeled the same as this one for (i=0;i<=vf.nfields.value;i++) { if ((i!=tf) && (eval('vf.f'+i+'.selectedIndex')==nw)) { - eval('vf.f'+i+'.selectedIndex=0;') - } + eval('vf.f'+i+'.selectedIndex=0;') + } } + // If we set this to 'lastname, firstnames', clear out all the ones + // set to 'fname','mname','lname','gen' (3,4,5,6) currently. 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 we set this to one of 'fname','mname','lname','gen' (3,4,5,6), + // clear out any that are set to 'lastname, firstnames' (2) 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 we set the password, make the password form below correspond to + // the new value. if (nw==9) { - vf.login[1].checked=true; - vf.intpwd.value=''; - vf.krbdom.value=''; + changed_radio('int',document.studentform); + set_auth_radio_buttons('int',document.studentform); + vf.intarg.value=''; + vf.krbarg.value=''; vf.locarg.value=''; } - } function clearpwd(vf) { @@ -348,70 +392,83 @@ function clearpwd(vf) { if (eval('vf.f'+i+'.selectedIndex')==9) { eval('vf.f'+i+'.selectedIndex=0;') } - } -} - -function setkrb(vf) { - if (vf.krbdom.value!='') { - clearpwd(vf); - vf.login[0].checked=true; - vf.krbdom.value=vf.krbdom.value.toUpperCase(); - vf.intpwd.value=''; - } + } } -function setint(vf) { - if (vf.intpwd.value!='') { - clearpwd(vf); - vf.login[1].checked=true; - vf.krbdom.value=''; - } +ENDPICK } -function clickkrb(vf) { - vf.krbdom.value='$krbdefdom'; - clearpwd(vf); - vf.intpwd.value=''; +############################################################### +############################################################### +sub upload_manager_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 clickint(vf) { - vf.krbdom.value=''; +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 pclose() { - parmwin=window.open("/adm/rat/empty.html","LONCAPAparms", - "height=350,width=350,scrollbars=no,menubar=no"); - parmwin.close(); - } - - function pjump(type,dis,value,marker,ret,call) { - parmwin=window.open("/adm/rat/parameter.html?type="+escape(type) - +"&value="+escape(value)+"&marker="+escape(marker) - +"&return="+escape(ret) - +"&call="+escape(call)+"&name="+escape(dis),"LONCAPAparms", - "height=350,width=350,scrollbars=no,menubar=no"); - - } - - function dateset() { - if (document.studentform.pres_marker.value=='end') { - document.studentform.enddate.value= - document.studentform.pres_value.value; - } - if (document.studentform.pres_marker.value=='start') { - document.studentform.startdate.value= - document.studentform.pres_value.value; - } - pclose(); +function clearpwd(vf) { + var i; + if (eval('vf.f8.selectedIndex')!=0) { + eval('vf.f8.selectedIndex=0;') } - - - +} ENDPICK } -sub phase_two_end { +############################################################### +############################################################### +sub print_upload_manager_footer { my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_; + + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); + my %param = ( formname => 'document.studentform', + kerb_def_dom => $krbdefdom, + kerb_def_auth => $krbdef + ); + 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); + my $date_table = &date_setting_table(); $r->print(< @@ -419,35 +476,20 @@ sub phase_two_end {

Login Type

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

- -Kerberos authenticated with domain - +$krbform

- -Internally authenticated (with initial password -) +$intform

- -Local Authentication with argument - +$locform

LON-CAPA Domain for Students

-LON-CAPA domain:

+LON-CAPA domain: $domform

Starting and Ending Dates

- - - - - -Set Starting Date

- -Set Ending Date

+

+$date_table +

Full Update

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

@@ -455,145 +497,357 @@ LON-CAPA domain: 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. +
+Note: for large courses, this operation may be time consuming. ENDPICK } -# ======================================================= Menu Phase Two Upload -sub menu_phase_two_upload { +# ======================================================= Menu Phase Two Upload +sub print_upload_manager_form { my $r=shift; - my $datatoken=&upfile_store($r); - - my @records=&upfile_record_sep(); + 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 %sone; my %stwo; my %sthree; - my $i=0; - + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); + &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom); + my $i; + my $keyfields; if ($total>=0) { - %sone=&record_sep($records[0]); - if ($total>=1) { - %stwo=&record_sep($records[1]); - } - if ($total>=2) { - %sthree=&record_sep($records[2]); - } - foreach (sort keys %sone) { - $r->print('

'); - $i++; + 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'], + ['email','EMail Address']); + 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))); } - $i--; } - my $keyfields=join(',',sort keys %sone); - - &phase_two_end($r,$i,$keyfields,$defdom,$today,$halfyear); + &print_upload_manager_footer($r,$i,$keyfields,$defdom,$today,$halfyear); } # ======================================================= Enroll single student - sub enroll_single_student { my $r=shift; + # + # We do the dates first because the action of making them the defaul + # in the course is entirely seperate from the action of enrolling the + # student. Also, a failure in setting the dates as default is not fatal + # to the process of enrolling / modifying a student. + my ($startdate,$enddate) = &get_dates_from_form(); + if ($ENV{'form.makedatesdefault'}) { + $r->print(&make_dates_default($startdate,$enddate)); + } + $r->print('

Enrolling Student

'); + $r->print('

Enrolling '.$ENV{'form.cuname'}." \@ ". + $ENV{'form.lcdomain'}.'

'); if (($ENV{'form.cuname'})&&($ENV{'form.cuname'}!~/\W/)&& - ($ENV{'form.cdomain'})&&($ENV{'form.cdomain'}!~/\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_library_servers($domain); + if (! exists($home_servers{$desiredhost})) { + $r->print('Error:'. + 'Invalid home server specified'); + return; + } + } + $r->print(" with server $desiredhost :") if (defined($desiredhost)); + # End of home server selection logic my $amode=''; my $genpwd=''; if ($ENV{'form.login'} eq 'krb') { - $amode='krb4'; - $genpwd=$ENV{'form.krbdom'}; + $amode='krb'; + $amode.=$ENV{'form.krbver'}; + $genpwd=$ENV{'form.krbarg'}; } elsif ($ENV{'form.login'} eq 'int') { $amode='internal'; - $genpwd=$ENV{'form.intpwd'}; + $genpwd=$ENV{'form.intarg'}; } elsif ($ENV{'form.login'} eq 'loc') { $amode='localauth'; $genpwd=$ENV{'form.locarg'}; if (!$genpwd) { $genpwd=" "; } } - if (($amode) && ($genpwd)) { - &dropstudent($ENV{'form.cdomain'},$ENV{'form.cuname'}, - $ENV{'request.course.id'},$ENV{'form.csec'}); - $r->print(&Apache::lonnet::modifystudent( - $ENV{'form.cdomain'},$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'})); + my $home = &Apache::lonnet::homeserver($ENV{'form.cuname'}, + $ENV{'form.lcdomain'}); + if ((($amode) && ($genpwd)) || ($home ne 'no_host')) { + # Clean out any old roles the student has in this class. + &modifystudent($ENV{'form.lcdomain'},$ENV{'form.cuname'}, + $ENV{'request.course.id'},$ENV{'form.csec'}, + $desiredhost); + my $login_result = &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'},$enddate, + $startdate,$ENV{'form.forceid'}, + $desiredhost); + if ($login_result =~ /^ok/) { + $r->print($login_result); + $r->print("

If active, the new role will be available ". + "when the student next logs in to LON-CAPA.

"); + } else { + $r->print("unable to enroll: ".$login_result); + } } else { - $r->print('Invalid login mode or password'); + $r->print('

ERROR '. + 'Invalid login mode or password. '. + 'Unable to enroll '.$ENV{'form.cuname'}.'.

'); } } else { $r->print('Invalid username or domain'); } } -# ======================================================= Menu Phase Two Enroll - -sub menu_phase_two_enroll { - my $r=shift; - - $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; - my $krbdefdom=$1; - $krbdefdom=~tr/a-z/A-Z/; - - my $today=time; - my $halfyear=$today+15552000; +sub setup_date_selectors { + my ($starttime,$endtime) = @_; + if (! defined($starttime)) { + $starttime = time; + if (exists($ENV{'course.'.$ENV{'request.course.id'}. + '.default_enrollment_start_date'})) { + $starttime = $ENV{'course.'.$ENV{'request.course.id'}. + '.default_enrollment_start_date'}; + } + } + if (! defined($endtime)) { + $endtime = time+(6*30*24*60*60); # 6 months from now, approx + if (exists($ENV{'course.'.$ENV{'request.course.id'}. + '.default_enrollment_end_date'})) { + $endtime = $ENV{'course.'.$ENV{'request.course.id'}. + '.default_enrollment_end_date'}; + } + } + my $startdateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'startdate', + $starttime); + my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'enddate', + $endtime); + return ($startdateform,$enddateform); +} + +sub get_dates_from_form { + my $startdate = &Apache::lonhtmlcommon::get_date_from_form('startdate'); + my $enddate = &Apache::lonhtmlcommon::get_date_from_form('enddate'); + if ($ENV{'form.no_end_date'}) { + $enddate = 0; + } + return ($startdate,$enddate); +} + +sub date_setting_table { + my ($starttime,$endtime) = @_; + my ($startform,$endform)=&setup_date_selectors($starttime,$endtime); + my $dateDefault = ''. + ''. + ' make these dates the default for future enrollment'; + my $perpetual = ''; + my $result = ''; + $result .= "
FieldSamples
'); - if (defined($sone{$_})) { - $r->print($sone{$_}."
\n"); - } - if (defined($stwo{$_})) { - $r->print($stwo{$_}."
\n"); - } - if (defined($sthree{$_})) { - $r->print($sthree{$_}."
\n"); - } - $r->print('
\n"; + $result .= ''. + ''. + ''."\n"; + $result .= ''. + ''. + ''."\n"; + $result .= "
Starting Date'.$startform.''.$dateDefault.'
Ending Date'.$endform.''.$perpetual.'
\n"; + return $result; +} + +sub make_dates_default { + my ($startdate,$enddate) = @_; + my $result = ''; + my $dom = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; + my $crs = $ENV{'course.'.$ENV{'request.course.id'}.'.num'}; + my $put_result = &Apache::lonnet::put('environment', + {'default_enrollment_start_date'=>$startdate, + 'default_enrollment_end_date' =>$enddate},$dom,$crs); + if ($put_result eq 'ok') { + $result .= "Set default start and end dates for course
"; + # + # Refresh the course environment + &Apache::lonnet::coursedescription($ENV{'request.course.id'}); + } else { + $result .= "Unable to set default dates for course:".$put_result. + '
'; + } + return $result; +} - my $defdom=$r->dir_config('lonDefDomain'); +## +## Single student enrollment routines (some of them) +## +sub get_student_username_domain_form { + my $r = shift; + my $domform = &Apache::loncommon::select_dom_form + ($r->dir_config('lonDefDomain'),'cudomain',0); + $r->print(< + +

Enroll One Student

+ + + + + + + +
Username:
Domain:$domform
  + +
+END + return; +} - $r->print(< +sub print_enroll_single_student_form { + my $r=shift; + $r->print("

Enroll One Student

"); + # + my $username = $ENV{'form.cuname'}; + my $domain = $ENV{'form.cudomain'}; + my $home = &Apache::lonnet::homeserver($username,$domain); + # $new_user flags whether we are creating a new user or using an old one + my $new_user = 1; + if ($home ne 'no_host') { + $new_user = 0; + } + &Apache::lonnet::logthis('home = '.$home); + # + my $user_data_html = ''; + my $javascript_validations = ''; + if ($new_user) { + my $defdom=$r->dir_config('lonDefDomain'); + # Set up authentication forms + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($domain); + $javascript_validations=&javascript_validations($krbdefdom); + my %param = ( formname => 'document.studentform', + kerb_def_dom => $krbdefdom, + kerb_def_auth => $krbdef + ); + 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 $homeserver_form = ''; + my %servers = &Apache::loncommon::get_library_servers($domain); + $homeserver_form = '\n"; + # + # + $user_data_html = <User Data for $username\@$domain + + + + + + + + + + + +
First Name:
Middle Name:
Last Name:
Generation:
Home Server:$homeserver_form
+

Password

+Please select an authentication mechanism + +

+$krbform +
+$intform +
+$locform +

+END + } else { + # User already exists. Do not worry about authentication + my %uenv = &Apache::lonnet::dump('environment',$domain,$username); + $javascript_validations = &javascript_validations_without_auth(); + $user_data_html = <User Data for $username\@$domain + +
+ + + + + + + + +
First Name: + +
Middle Name: + +
Last Name: + +
Generation: + +
+END + } + my $date_table = &date_setting_table(); + # Print it all out + $r->print(< + + + + -function clickkrb(vf) { - vf.krbdom.value='$krbdefdom'; - vf.intpwd.value=''; - vf.locarg.value=''; -} +$user_data_html -function clickint(vf) { - vf.krbdom.value=''; - vf.locarg.value=''; -} +

Course Data

-function clickloc(vf) { - vf.krbdom.value=''; - vf.intpwd.value=''; +

Group/Section: +

+$date_table +

+

ID/Student Number

+

+ID/Student Number: +

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

+ +

+END + return; } - function pclose() { - parmwin=window.open("/adm/rat/empty.html","LONCAPAparms", - "height=350,width=350,scrollbars=no,menubar=no"); - parmwin.close(); +# ========================================================= Menu Phase Two Drop +sub print_drop_menu { + my $r=shift; + $r->print("

Drop Students

"); + my $cid=$ENV{'request.course.id'}; + my ($classlist,$keylist) = &Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print("There are no students currently enrolled.\n"); + return; } + # Print out the available choices + &show_drop_list($r,$classlist,$keylist); + return; +} - function pjump(type,dis,value,marker,ret,call) { - parmwin=window.open("/adm/rat/parameter.html?type="+escape(type) - +"&value="+escape(value)+"&marker="+escape(marker) - +"&return="+escape(ret) - +"&call="+escape(call)+"&name="+escape(dis),"LONCAPAparms", - "height=350,width=350,scrollbars=no,menubar=no"); +# ============================================== view classlist +sub print_html_classlist { + my $r=shift; + if (! exists($ENV{'form.sortby'})) { + $ENV{'form.sortby'} = 'username'; + } + if ($ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { + $ENV{'form.Status'} = 'Active'; + } + my $status_select = &Apache::lonhtmlcommon::StatusOptions + ($ENV{'form.Status'},'studentform'); + $r->print(< + +

+Current Class List +      +END + if ($ENV{'form.action'} ne 'modifystudent') { + $r->print(< +CSV format +         +Excel format + +      +Student Status: +END + } + $r->print($status_select."

\n"); + my $cid=$ENV{'request.course.id'}; + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print("There are no students currently enrolled.\n"); + } else { + # Print out the available choices + if ($ENV{'form.action'} eq 'modifystudent') { + &show_class_list($r,'view','modify','modifystudent', + $ENV{'form.Status'},$classlist,$keylist); + } else { + &show_class_list($r,'view','aboutme','classlist', + $ENV{'form.Status'},$classlist,$keylist); + } + } +} +# ============================================== view classlist +sub print_formatted_classlist { + my $r=shift; + my $mode = shift; + my $cid=$ENV{'request.course.id'}; + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print("There are no students currently enrolled.\n"); + } else { + &show_class_list($r,$mode,'nolink','csv', + $ENV{'form.Status'},$classlist,$keylist); } +} + +# =================================================== Show student list to drop +sub show_class_list { + my ($r,$mode,$linkto,$action,$statusmode,$classlist,$keylist)=@_; + my $cid=$ENV{'request.course.id'}; + # + # Variables for excel output + my ($excel_workbook, $excel_sheet, $excel_filename,$row); + # + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id)$/) { + $sortby = 'username'; + } + # Print out header + if ($mode eq 'view') { + if ($linkto eq 'aboutme') { + $r->print('Select a user name to view the users personal page.'); + } elsif ($linkto eq 'modify') { + $r->print('Select a user name to modify the students information'); + } + $r->print(< + + +

+ + + +END + } elsif ($mode eq 'csv') { + if($statusmode eq 'Expired') { + $r->print('"Students with expired roles"'); } - if (document.studentform.pres_marker.value=='start') { - document.studentform.startdate.value= - document.studentform.pres_value.value; + if ($statusmode eq 'Any') { + $r->print('"'.join('","',("username","domain","ID","student name", + "section","status")).'"'."\n"); + } else { + $r->print('"'.join('","',("username","domain","ID","student name", + "section")).'"'."\n"); } - pclose(); + } elsif ($mode eq 'excel') { + # Create the excel spreadsheet + $excel_filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'. + $excel_filename); + $excel_workbook->set_tempdir('/home/httpd/perl/tmp'); + $excel_sheet = $excel_workbook->addworksheet('classlist'); + # + my $description = 'Class List for '. + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $excel_sheet->write($row++,0,$description); + # + $excel_sheet->write($row++,0,["username","domain","ID", + "student name","section","status"]); + } + # + # Sort the students + my %index; + my $i; + foreach (@$keylist) { + $index{$_} = $i++; + } + my $index = $index{$sortby}; + my $second = $index{'username'}; + my $third = $index{'domain'}; + my @Sorted_Students = sort { + lc($classlist->{$a}->[$index]) cmp lc($classlist->{$b}->[$index]) + || + lc($classlist->{$a}->[$second]) cmp lc($classlist->{$b}->[$second]) + || + lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third]) + } (keys(%$classlist)); + foreach my $student (@Sorted_Students) { + my $username = $classlist->{$student}->[$index{'username'}]; + my $domain = $classlist->{$student}->[$index{'domain'}]; + my $section = $classlist->{$student}->[$index{'section'}]; + my $name = $classlist->{$student}->[$index{'fullname'}]; + my $id = $classlist->{$student}->[$index{'id'}]; + my $status = $classlist->{$student}->[$index{'status'}]; + next if (($statusmode ne 'Any') && ($status ne $statusmode)); + if ($mode eq 'view') { + $r->print("\n + + + + + +END + } elsif ($mode eq 'csv') { + # no need to bother with $linkto + my @line = (); + foreach ($username,$domain,$id,$name,$section) { + push @line,&Apache::loncommon::csv_translate($_); + } + if ($statusmode eq 'Any') { + push @line,&Apache::loncommon::csv_translate($status); + } + my $tmp = $"; + $" = '","'; + $r->print("\"@line\"\n"); + $" = $tmp; + } elsif ($mode eq 'excel') { + $excel_sheet->write($row++,0,[$username,$domain,$id, + $name,$section,$status]); + } + } + if ($mode eq 'view') { + $r->print('
+ username + + domain + + ID + + student name + + section +
\n "); + if ($linkto eq 'nothing') { + $r->print($username); + } elsif ($linkto eq 'aboutme') { + $r->print(&Apache::loncommon::aboutmewrapper($username, + $username, + $domain)); + } elsif ($linkto eq 'modify') { + $r->print(''. + $username."\n"); + } + $r->print(<<"END"); + $domain$id$name$section

'); + } elsif ($mode eq 'excel') { + $excel_workbook->close(); + $r->print('

'. + 'Your Excel spreadsheet is ready for download.

'."\n"); } +} - -

Personal Data

-First Name:
-Middle Name:
-Last Name:
-Generation:

- -ID/Student Number:

- -Group/Section:

- -

Login Data

-Username:

-Domain:

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

- - -Kerberos authenticated with domain -

- -Internally authenticated (with initial password -) + +# +# print out form for modification of a single students data +# +sub print_modify_student_form { + my $r = shift(); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sdom','sname']); + my $sname = $ENV{'form.sname'}; + my $sdom = $ENV{'form.sdom'}; + my $sortby = $ENV{'form.sortby'}; + # determine the students name information + my %info=&Apache::lonnet::get('environment', + ['firstname','middlename', + 'lastname','generation','id'], + $sdom, $sname); + my ($tmp) = keys(%info); + if ($tmp =~ /^(con_lost|error|no_such_host)/i) { + $r->print('Error'. + '

'. + 'Unable to retrieve environment data for '.$sname. + 'in domain '.$sdom.'

'. + 'Please contact your LON-CAPA administrator '. + 'regarding this situation.

'); + return; + } + # determine the students starting and ending times and section + my ($starttime,$endtime,$section) = &get_enrollment_data($sname,$sdom); + # Deal with date forms + my $date_table = &date_setting_table($starttime,$endtime); + # + if (! exists($ENV{'form.Status'}) || + $ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { + $ENV{'form.Status'} = 'crap'; + } + # Make sure student is enrolled in course + $r->print(< - -Local Authentication with argument - + +Only domain coordinators can change a users password. +

-

Starting and Ending Dates

- - - - - -Set Starting Date

- -Set Ending Date

-

ID/Student Number

- + + + + + + + +

Modify Enrollment for $info{'firstname'} $info{'middlename'} +$info{'lastname'} $info{'generation'}, $sname\@$sdom

+

+Student Name + + + +
FirstMiddleLastGeneration
+ + + +
+

+Student ID: +

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

-
- -ENDSENROLL +(only do if you know what you are doing) +

+Section: +

+

$date_table

+ + +END + return; } -# ========================================================= Menu Phase Two Drop - -sub menu_phase_two_drop { - my $r=shift; - my $cid=$ENV{'request.course.id'}; - my $classlst=&Apache::lonnet::reply - ('dump:'.$ENV{'course.'.$cid.'.domain'}.':'. - $ENV{'course.'.$cid.'.num'}.':classlist', - $ENV{'course.'.$cid.'.home'}); - my %currentlist=(); - my $now=time; - unless ($classlst=~/^error\:/) { - foreach (split(/\&/,$classlst)) { - my ($name,$value)=split(/\=/,$_); - my ($end,$start)=split(/\:/, - &Apache::lonnet::unescape($value)); - my $active=1; - if (($end) && ($now>$end)) { $active=0; } - if ($active) { - $currentlist{&Apache::lonnet::unescape($name)}=1; - } - } -# ----------------------------------------------------------- Print out choices - &show_drop_list($r,%currentlist); - } else { - $r->print( - '

Could not access classlist: '.$classlst. - '

'); - } +# +# modify a single students section +# +sub modify_single_student { + my $r = shift; + # + # Do the date defaults first + my ($starttime,$endtime) = &get_dates_from_form(); + if ($ENV{'form.makedatesdefault'}) { + $r->print(&make_dates_default($starttime,$endtime)); + } + # Get the 'sortby' and 'Status' variables so the user goes back to their + # previous screen + my $sortby = $ENV{'form.sortby'}; + my $status = $ENV{'form.Status'}; + # + # We always need this information + my $slogin = $ENV{'form.slogin'}; + my $sdom = $ENV{'form.sdomain'}; + # + # Get the old data + my %old=&Apache::lonnet::get('environment', + ['firstname','middlename', + 'lastname','generation','id'], + $sdom, $slogin); + $old{'section'} = &Apache::lonnet::getsection($sdom,$slogin, + $ENV{'request.course.id'}); + my ($tmp) = keys(%old); + if ($tmp =~ /^(con_lost|error|no_such_host)/i) { + $r->print("There was an error determining the environment values ". + " for $slogin \@ $sdom."); + return; + } + undef $tmp; + # + # Get the new data + my $firstname = $ENV{'form.firstname'}; + my $middlename = $ENV{'form.middlename'}; + my $lastname = $ENV{'form.lastname'}; + my $generation = $ENV{'form.generation'}; + my $section = $ENV{'form.section'}; + my $courseid = $ENV{'request.course.id'}; + my $sid = $ENV{'form.id'}; + my $displayable_starttime = localtime($starttime); + my $displayable_endtime = localtime($endtime); + # + # check for forceid override + if ((defined($old{'id'})) && ($old{'id'} ne '') && + ($sid ne $old{'id'}) && (! exists($ENV{'form.forceid'}))) { + $r->print("You changed the students id ". + " but did not disable the ID change safeguard.". + " The students id will not be changed."); + $sid = $old{'id'}; + } + # + # talk to the user about what we are going to do + $r->print(<Modifying data for user $slogin \@ $sdom +

Student Information

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Old Value New Value
First name $old{'firstname'} $firstname
Middle name $old{'middlename'} $middlename
Last name $old{'lastname'} $lastname
Generation $old{'generation'} $generation
ID $old{'id'} $sid
Section $old{'section'} $section
+

Role Information

+ + + +
Start Time: $displayable_starttime
End Time: $displayable_endtime
+

+END + # + # Send request(s) to modify data (final undef is for 'desiredhost', + # which is a moot point because the student already has an account. + my $modify_section_results = &modifystudent($sdom,$slogin, + $ENV{'request.course.id'}, + $section,undef); + if ($modify_section_results !~ /^ok/) { + $r->print("An error occured during the attempt to change the ". + "section for this student.
"); + } + my $roleresults = &Apache::lonnet::modifystudent + ($sdom,$slogin,$sid,undef,undef,$firstname,$middlename,$lastname, + $generation,$section,$endtime,$starttime,$ENV{'form.forceid'}); + if ($roleresults eq 'refused' ) { + $r->print("Your request to change the role information for this ". + "student was refused. You do not appear to have ". + "sufficient authority to change student information."); + } elsif ($roleresults !~ /ok/) { + $r->print("An error occurred during the attempt to change the role". + " information for this student.
". + "The error reported was ". + $roleresults); + &Apache::lonnet::logthis("londropadd:failed attempt to modify student". + " data for ".$slogin." \@ ".$sdom." by ". + $ENV{'user.name'}." \@ ".$ENV{'user.domain'}. + ":".$roleresults); + } else { # everything is okay! + $r->print("Student information updated successfully.
". + "The student must log out and log in again to see ". + "these changes."); + } + $r->print(<

+ + + +Modify another students data + +END + return; +} + +sub get_enrollment_data { + my ($sname,$sdomain) = @_; + my $courseid = $ENV{'request.course.id'}; + $courseid =~ s:_:/:g; + my %roles = &Apache::lonnet::dump('roles',$sdomain,$sname); + my ($tmp) = keys(%roles); + # Bail out if we were unable to get the students roles + return "666" if ($tmp =~ /^(con_lost|error|no_such_host)/i); + # Go through the roles looking for enrollment in this course + my ($end,$start) = (undef,undef); + my $section = ''; + my $count = scalar(keys(%roles)); + while (my ($course,$role) = each(%roles)) { + if ($course=~ /^\/$courseid\/*\s*(\w+)*_st$/ ) { + # + # Get active role + $section=$1; + (undef,$end,$start)=split(/\_/,$role); + my $now=time; + my $notactive=0; + if ($start) { + if ($now<$start) { $notactive=1; } + } + if ($end) { + if ($now>$end) { $notactive=1; } + } + unless ($notactive) { return ($start,$end,$section); } + } + } + return ($start,$end,$section); } -# =================================================== Show student list to drop +################################################# +################################################# + +=pod + +=item show_drop_list + +Display a list of students to drop +Inputs: + +=over 4 + +=item $r, Apache request +=item $classlist, hash pointer returned from loncoursedata::get_classlist(); + +=item $keylist, array pointer returned from loncoursedata::get_classlist() +which describes the order elements are stored in the %$classlist values. + +=item $nosort, if true, sorting links are omitted. + +=back + +=cut + +################################################# +################################################# sub show_drop_list { - my ($r,%currentlist)=@_; + my ($r,$classlist,$keylist,$nosort)=@_; my $cid=$ENV{'request.course.id'}; + if (! exists($ENV{'form.sortby'})) { + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sortby']); + } + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id)$/) { + $sortby = 'username'; + } + # + my $action = "drop"; + $r->print(< + + + +

+ +END -# ================================================= Drop/Add from uploaded file + if ($nosort) { + $r->print(< + +   + username + domain + ID + student name + section + +END + + } else { + $r->print(< +  + + username + + domain + + ID + + student name + + section + + +END + } + # + # Sort the students + my %index; + my $i; + foreach (@$keylist) { + $index{$_} = $i++; + } + my $index = $index{$sortby}; + my $second = $index{'username'}; + my $third = $index{'domain'}; + my @Sorted_Students = sort { + lc($classlist->{$a}->[$index]) cmp lc($classlist->{$b}->[$index]) + || + lc($classlist->{$a}->[$second]) cmp lc($classlist->{$b}->[$second]) + || + lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third]) + } (keys(%$classlist)); + foreach my $student (@Sorted_Students) { + my $error; + my $username = $classlist->{$student}->[$index{'username'}]; + my $domain = $classlist->{$student}->[$index{'domain'}]; + my $section = $classlist->{$student}->[$index{'section'}]; + my $name = $classlist->{$student}->[$index{'fullname'}]; + my $id = $classlist->{$student}->[$index{'id'}]; + my $status = $classlist->{$student}->[$index{'status'}]; + next if ($status ne 'Active'); + # + $r->print(<<"END"); + + + $username + $domain + $id + $name + $section + +END + } + $r->print('
'); + $r->print(<<"END"); +

+   + +

+END + return; +} -sub upfile_drop_add { +# +# Print out the initial form to get the courselist file +# +sub print_first_courselist_upload_form { my $r=shift; + my $upfile_select=&Apache::loncommon::upfile_select_html(); + my $create_classlist_help = + &Apache::loncommon::help_open_topic("Course_Create_Class_List", + "How do I create a class list from a spreadsheet"); + my $create_csv_help = + &Apache::loncommon::help_open_topic("Course_Convert_To_CSV", + "How do I create a CSV file from a spreadsheet"); + $r->print(< +

Upload a courselist

+$upfile_select +

+ + + +

+$create_classlist_help
+$create_csv_help + +ENDUPFORM + return; +} - &load_tmp_file($r); - my @studentdata=&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++) { - $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=''; } - my $domain=$ENV{'form.lcdomain'}; - my $amode=''; - my $genpwd=''; - if ($ENV{'form.login'} eq 'krb') { - $amode='krb4'; - $genpwd=$ENV{'form.krbdom'}; - } elsif ($ENV{'form.login'} eq 'int') { - $amode='internal'; - if ((defined($ENV{'form.intpwd'})) && ($ENV{'form.intpwd'})) { - $genpwd=$ENV{'form.intpwd'}; - } - } 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 '')) { - $r->print('

Enrolling Students

'); - my $count=0; - my $flushc=0; - my %student=(); -# ----------------------------------------------------------- Get new classlist -# --------------------------------------------------------- Enroll new students - foreach (@studentdata) { - my %entries=&record_sep($_); - - unless (($entries{$fields{'username'}} eq '') || - (!defined($entries{$fields{'username'}}))) { - my $fname=''; my $mname=''; my $lname=''; my $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: '. +# ================================================= 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,$enddate) = &get_dates_from_form(); + if ($ENV{'form.makedatesdefault'}) { + $r->print(&make_dates_default($startdate,$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_library_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='krb'; + $amode.=$ENV{'form.krbver'}; + $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

'."\n".'

'); + 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 { - my $sec=''; - my $username=$entries{$fields{'username'}}; - if (defined($fields{'sec'})) { - if (defined($entries{$fields{'sec'}})) { - $sec=$entries{$fields{'sec'}}; - } - } - my $id=''; - if (defined($fields{'id'})) { - if (defined($entries{$fields{'id'}})) { - $id=$entries{$fields{'id'}}; - } - $id=~tr/A-Z/a-z/; - } - my $password=''; - if ($genpwd) { - $password=$genpwd; - } else { - if (defined($fields{'ipwd'})) { - if ($entries{$fields{'ipwd'}}) { - $password=$entries{$fields{'ipwd'}}; - } - } - } - if ($password) { - &dropstudent($domain,$username,$cid,$sec); - my $reply=&Apache::lonnet::modifystudent( - $domain,$username,$id,$amode,$password, - $fname,$mname,$lname,$gen,$sec,$enddate,$startdate, - $ENV{'form.forceid'}); - unless ($reply eq 'ok') { - $r->print( - "

Error enrolling $username: $reply

"); + $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 email address + my $email=''; + if (defined($fields{'email'})) { + if (defined($entries{$fields{'email'}})) { + $email=$entries{$fields{'email'}}; + unless ($email=~/^[^\@]+\@[^\@]+$/) { $email=''; } + } + } + # determine student password + my $password=''; + if ($genpwd) { + $password=$genpwd; + } else { + if (defined($fields{'ipwd'})) { + if ($entries{$fields{'ipwd'}}) { + $password=$entries{$fields{'ipwd'}}; + } + } + } + # Clean up whitespace + foreach (\$domain,\$username,\$id,\$fname,\$mname, + \$lname,\$gen,\$sec) { + $$_ =~ s/(\s+$|^\s+)//g; + } + if ($password) { + &modifystudent($domain,$username,$cid,$sec, + $desiredhost); + my $reply=&Apache::lonnet::modifystudent + ($domain,$username,$id,$amode,$password, + $fname,$mname,$lname,$gen,$sec,$enddate, + $startdate,$ENV{'form.forceid'},$desiredhost, + $email); + if ($reply ne 'ok') { + $reply =~ s/^error://; + $r->print('
'.$username.':'. + ' Unable to enroll: '.$reply); } else { $count++; $flushc++; $student{$username}=1; @@ -947,142 +1678,207 @@ sub upfile_drop_add { $flushc=0; } } - } else { - $r->print( - "

No password for $username

"); - } - } - } - } - $r->print('

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

Dropping Students

'); -# ------------------------------------------------------- Get current classlist - my $classlst=&Apache::lonnet::reply - ('dump:'.$ENV{'course.'.$cid.'.domain'}.':'. - $ENV{'course.'.$cid.'.num'}.':classlist', - $ENV{'course.'.$cid.'.home'}); - my %currentlist=(); - my $now=time; - unless ($classlst=~/^error\:/) { - foreach (split(/\&/,$classlst)) { - my ($name,$value)=split(/\=/,$_); - my ($end,$start)=split(/\:/, - &Apache::lonnet::unescape($value)); - my $active=1; - if (($end) && ($now>$end)) { $active=0; } - if ($active) { - $currentlist{&Apache::lonnet::unescape($name)}=1; - } - } -# ------------------------------------------------ Now got up-to-date classlist - foreach (@studentdata) { - my %entries=&record_sep($_); - unless (($entries{$fields{'username'}} eq '') || - (!defined($entries{$fields{'username'}}))) { - delete($currentlist{ - $entries{$fields{'username'}}.':'. - $domain}); - } - } -# ----------------------------------------------------------- Print out choices - &show_drop_list($r,%currentlist); - } else { - $r->print( - '

Could not access classlist: '.$classlst. - '

'); - } - } -# ------------------------------------------------------------------------ Done - - } + } else { + $r->print('
'.$username.':'. + ' Unable to enroll: No password specified.'); + } + } + } + } # end of foreach (@studentdata) + $r->print('

Processed Students: '.$count.'

'); + $r->print("

If active, the new role will be available when the ". + "students next log in to LON-CAPA.

"); + ##################################### + # Drop students # + ##################################### + if ($ENV{'form.fullup'} eq 'yes') { + $r->print('

Dropping Students

'); + # Get current classlist + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print("There are no students currently enrolled.\n"); + } else { + # Remove the students we just added from the list of students. + foreach (@studentdata) { + my %entries=&Apache::loncommon::record_sep($_); + unless (($entries{$fields{'username'}} eq '') || + (!defined($entries{$fields{'username'}}))) { + delete($classlist->{$entries{$fields{'username'}}. + ':'.$domain}); + } + } + # Print out list of dropped students. + &show_drop_list($r,$classlist,$keylist,'nosort'); + } + } + } # end of unless } # ================================================================== Phase four - sub drop_student_list { my $r=shift; my $count=0; - foreach (keys %ENV) { - if ($_=~/^form\.drop\:/) { - my ($dummy,$uname,$udom)=split(/\:/,$_); - &dropstudent($udom,$uname,$ENV{'request.course.id'}); - $r->print('Dropped '.$uname.' at '.$udom.'
'); + my @droplist; + if (ref($ENV{'form.droplist'})) { + @droplist = @{$ENV{'form.droplist'}}; + } else { + @droplist = ($ENV{'form.droplist'}); + } + foreach (@droplist) { + my ($uname,$udom)=split(/\:/,$_); + # drop student + my $result = &modifystudent($udom,$uname,$ENV{'request.course.id'}); + if ($result eq 'ok' || $result eq 'ok:') { + $r->print('Dropped '.$uname.' @ '.$udom.'
'); $count++; + } else { + $r->print('Error dropping '.$uname.' @ '.$udom.': '.$result. + '
'); } } $r->print('

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

Re-enrollment will re-activate data.'); + $r->print('

Re-enrollment will re-activate data.') if ($count); } -# ================================================================ 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; - &header($r); - -# --------------------------------------------------- Phase one, initial screen - unless ($ENV{'form.phase'}) { - &menu_phase_one($r); - } -# ------------------------------------------------------------------- Phase two - 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); - } - } +################################################################### +################################################################### +=pod +=item &handler + +The typical handler you see in all these modules. Takes $r, the +http request, as an argument. + +The response to the request is governed by two form variables + + form.action form.state response + --------------------------------------------------- + undefined undefined print main menu + upload undefined print courselist upload menu + upload got_file deal with uploaded file, + print the upload managing menu + upload enrolling enroll students based on upload + drop undefined print the classlist ready to drop + drop done drop the selected students + enrollstudent undefined print student username domain form + enrollstudent gotusername print single student enroll menu + enrollstudent enrolling enroll student + classlist undefined print html classlist + classlist csv print csv classlist + modifystudent undefined print classlist to select student to modify + modifystudent selected print modify student menu + modifystudent done make modifications to student record +=cut -# ----------------------------------------------------------------- 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 four - 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; +################################################################### +################################################################### +sub handler { + my $r=shift; + if ($r->header_only) { + $r->content_type('text/html'); + $r->send_http_header; + return OK; + } + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['action','state']); + # Needs to be in a course + if (! (($ENV{'request.course.fn'}) && + (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'})))) { + # 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; + } + # + # Only output the header information if they did not request csv format + # + if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) { + $r->content_type('text/csv'); + } else { + # Start page + $r->content_type('text/html'); + $r->send_http_header; + $r->print(&header()); + } + # + # Main switch on form.action and form.state, as appropriate + if (! exists($ENV{'form.action'})) { + &print_main_menu($r); + } elsif ($ENV{'form.action'} eq 'upload') { + if (! exists($ENV{'form.state'})) { + &print_first_courselist_upload_form($r); + } elsif ($ENV{'form.state'} eq 'got_file') { + &print_upload_manager_form($r); + } elsif ($ENV{'form.state'} eq 'enrolling') { + if ($ENV{'form.datatoken'}) { + &upfile_drop_add($r); + } else { + # Hmmm, this is an error + } + } else { + &print_first_courselist_upload_form($r); + } + } elsif ($ENV{'form.action'} eq 'drop') { + if (! exists($ENV{'form.state'})) { + &print_drop_menu($r); + } elsif ($ENV{'form.state'} eq 'done') { + &drop_student_list($r); + } else { + &print_drop_menu($r); + } + } elsif ($ENV{'form.action'} eq 'enrollstudent') { + if (! exists($ENV{'form.state'})) { + &get_student_username_domain_form($r); + } elsif ($ENV{'form.state'} eq 'gotusername') { + &print_enroll_single_student_form($r); + } elsif ($ENV{'form.state'} eq 'enrolling') { + &enroll_single_student($r); + } else { + &get_student_username_domain_form($r); + } + } elsif ($ENV{'form.action'} eq 'classlist') { + if (! exists($ENV{'form.state'})) { + &print_html_classlist($r); + } elsif ($ENV{'form.state'} eq 'csv') { + &print_formatted_classlist($r,'csv'); + } elsif ($ENV{'form.state'} eq 'excel') { + &print_formatted_classlist($r,'excel'); + } else { + &print_html_classlist($r); + } + } elsif ($ENV{'form.action'} eq 'modifystudent') { + if (! exists($ENV{'form.state'})) { + &print_html_classlist($r); + } elsif ($ENV{'form.state'} eq 'selected') { + &print_modify_student_form($r); + } elsif ($ENV{'form.state'} eq 'done') { + &modify_single_student($r); + } else { + &print_html_classlist($r); + } + } else { + # We should not end up here, but I guess it is possible + &Apache::lonnet::logthis("Undetermined state in londropadd.pm. ". + "form.action = ".$ENV{'form.action'}. + "Someone should fix this."); + &print_main_menu($r); + } + # + # Finish up + if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) { + $r->print("\n"); + } else { + $r->print(''); + } + return OK; } +################################################################### +################################################################### + 1; __END__ - -