--- loncom/interface/Attic/londropadd.pm 2001/01/01 17:30:00 1.8 +++ loncom/interface/Attic/londropadd.pm 2004/02/10 22:15:53 1.100 @@ -1,214 +1,502 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# (Handler to set parameters for assessments +# $Id: londropadd.pm,v 1.100 2004/02/10 22:15:53 www Exp $ # -# (Handler to resolve ambiguous file locations +# Copyright Michigan State University Board of Trustees # -# (TeX Content Handler +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). # -# 05/29/00,05/30,10/11 Gerd Kortemeyer) +# 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. # -# 10/11,10/12,10/16 Gerd Kortemeyer) +# 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. # -# 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28, -# 12/08,12/12 Gerd Kortemeyer) +# 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 # -# 12/26,12/27,12/28, -# 01/01/01 Gerd Kortemeyer +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +# +############################################################### +############################################################## 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; +use Apache::lonlocal; +############################################################### +############################################################### +sub header { + my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager'). + &Apache::loncommon::help_open_faq(9). + &Apache::loncommon::help_open_bug('Instructor Interface'); + my $title = &mt('LON-CAPA Enrollment Manager'); + return(< + +$title + +$bodytag +
+ENDHEAD +} -# ================================================================ Main Handler +############################################################### +############################################################### +# 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 (defined($csec) && $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.':'; + } + } + } + } + if ($result eq '') { + $result = 'Unable to find section for this student'; + } else { + $result =~ s/(ok:)+/ok/g; + } + return $result; +} -sub handler { - my $r=shift; +############################################################### +############################################################### +# 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; +} - if ($r->header_only) { - $r->content_type('text/html'); - $r->send_http_header; - return OK; - } +############################################################### +############################################################### +# Menu Phase One +sub print_main_menu { + my $r=shift; + my %Text = &Apache::lonlocal::texthash + ('upload' => 'Upload a class list', + 'enrollone' => 'Enroll a single student', + 'modify' => 'Modify student data', + 'view' => 'View Class List', + 'drop' => 'Drop Students', + 'populate' => 'Automated Enrollment Manager'); + my %help=(); + foreach ('Course_Drop_Student','Course_Add_Student', + 'Course_Modify_Student_Data','Course_View_Class_List', + 'Course_Create_Class_List') { + $help{$_}=&Apache::loncommon::help_open_topic($_); + } -# ----------------------------------------------------- Needs to be in a course + $r->print(< + +$Text{'upload'} +$help{'Course_Create_Class_List'} +

+ + $Text{'enrollone'} + $help{'Course_Add_Student'} +

+ + $Text{'modify'} + $help{'Course_Modify_Student_Data'} +

+ + $Text{'view'} + $help{'Course_View_Class_List'} +

+ + $Text{'drop'} + $help{'Course_Drop_Student'} +

+ + $Text{'populate'} + +END +} - if (($ENV{'request.course.fn'}) && - (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'}))) { +############################################################### +############################################################### +sub hidden_input { + my ($name,$value) = @_; + return ''."\n"; +} -# ------------------------------------------------------------------ Start page - $r->content_type('text/html'); - $r->send_http_header; - $r->print(< - -LON-CAPA Student Drop/Add - - - -

Drop/Add Students

- -

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

-ENDHEAD -# --------------------------------------------------- Phase one, initial screen - unless ($ENV{'form.phase'}) { - $r->print(< -
-

Upload a courselist

- -
Type: -

-

-

Enroll a single student

-

-

-

Drop a student

-

-ENDUPFORM - } -# ------------------------------------------------------------------- Phase two - if ($ENV{'form.phase'} eq 'two') { - if ($ENV{'form.fileupload'}) { - 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'}; - } - my $separator=''; - my $remove=''; - if ($ENV{'form.upfiletype'} eq 'csv') { - $separator='\"\,\s*\"'; - $remove='"'; - } elsif ($ENV{'form.upfiletype'} eq 'space') { - $separator='\s+'; - } elsif ($ENV{'form.upfiletype'} eq 'tab') { - $separator='\t+'; - } elsif ($ENV{'form.upfiletype'} eq 'xml') { - } - my @lines=split(/\n/,$ENV{'form.upfile'}); - my $total=$#lines; - $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'); - $r->print(< - - -

-

Identify fields

-Total number of records found in file: $total -'); +} + +############################################################### +############################################################### +sub javascript_validations { + my ($mode,$krbdefdom,$curr_authtype,$curr_authfield)=@_; + my $authheader; + if ($mode eq 'auth') { + my %param = ( formname => 'studentform', + kerb_def_dom => $krbdefdom, + curr_authtype => $curr_authtype); + $authheader = &Apache::loncommon::authform_header(%param); + } elsif ($mode eq 'createcourse') { + my %param = ( formname => 'ccrs', + kerb_def_dom => $krbdefdom, + curr_authtype => $curr_authtype ); + $authheader = &Apache::loncommon::authform_header(%param); + } elsif ($mode eq 'modifycourse') { + my %param = ( formname => 'cmod', + kerb_def_dom => $krbdefdom, + mode => 'modifycourse', + curr_authtype => $curr_authtype, + curr_autharg => $curr_authfield ); + $authheader = &Apache::loncommon::authform_header(%param); + } + + + my %alert = &Apache::lonlocal::texthash + (username => 'You need to specify the username field.', + authen => 'You must choose an authentication type.', + krb => 'You need to specify the Kerberos domain.', + ipass => 'You need to specify the initial password.', + name => 'The optional name field was not specified.', + snum => 'The optional student number field was not specified.', + section => 'The optional section or group field was not specified.', + email => 'The optional email address field was not specified.', + continue => 'Continue enrollment?', + ); + +# my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition(); + my $function_name =(<=2) && (tw<=6)) { foundname=1; } if (tw==7) { foundid=1; } - if (tw==8) { foundsec=1; } + if (tw==8) { foundsec=1; } if (tw==9) { foundpwd=1; } + if (tw==10) { foundemail=1; } } - if (founduname==0) { - alert('You need to specify at least the username field'); - return; - } - if (vf.login[0].checked) { - foundatype=1; - if (vf.krbdom.value=='') { - alert('You need to specify the Kerberos domain'); - return; - } - } - if (vf.login[1].checked) { - foundatype=1; - if ((vf.intpwd.value=='') && (foundpwd==0)) { - alert('You need to specify the initial password'); - return; - } - } - if (foundatype==0) { - alert('You need to set the login type'); - return; - } - if (foundname==0) { message='No name fields specified. '; } - if (foundid==0) { message+='No ID or student number field specified. '; } - if (foundsec==0) { message+='No section or group field specified. '; } - if (vf.startdate.value=='') { - message+='No starting date set. '; - } - if (vf.enddate.value=='') { - message+='No ending date set. '; - } - if ((vf.enddate.value!='') && (vf.startdate.value!='')) { - if (vf.enddate.value=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) { @@ -217,258 +505,1466 @@ 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=''; - } +ENDPICK } -function setint(vf) { - if (vf.intpwd.value!='') { - clearpwd(vf); - vf.login[1].checked=true; - vf.krbdom.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 clickkrb(vf) { - vf.krbdom.value='$krbdefdom'; - clearpwd(vf); - vf.intpwd.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 clickint(vf) { - vf.krbdom.value=''; +function clearpwd(vf) { + var i; + if (eval('vf.f8.selectedIndex')!=0) { + eval('vf.f8.selectedIndex=0;') + } +} +ENDPICK } - function pclose() { - parmwin=window.open("/adm/rat/empty.html","LONCAPAparms", - "height=350,width=350,scrollbars=no,menubar=no"); - parmwin.close(); +############################################################### +############################################################### +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 + ); + if (exists($ENV{'form.ipwd_choice'}) && + defined($ENV{'form.ipwd_choice'}) && + $ENV{'form.ipwd_choice'} ne '') { + $param{'curr_authtype'} = 'int'; } + 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(); + my $Str = "\n"; + $Str .= &hidden_input('nfields',$i); + $Str .= &hidden_input('keyfields',$keyfields); + $Str .= '

'.&mt('Login Type')."

\n"; + $Str .= "

\n". + &mt('Note: this will not take effect if the user already exists'). + "

\n"; + $Str .= $krbform."\n

\n". + $intform."\n

\n". + $locform."\n

\n"; + $Str .= '

'.&mt('LON-CAPA Domain for Students')."

\n"; + $Str .= "

\n".&mt('LON-CAPA domain: [_1]',$domform)."\n

\n"; + $Str .= "

".&mt('Starting and Ending Dates')."

\n"; + $Str .= "

\n".$date_table."

\n"; + $Str .= "

".&mt('Full Update')."

\n"; + $Str .= ''. + ' '.&mt('Full update (also print list of users not enrolled anymore)'). + "

\n"; + $Str .= "

".&mt('Student Number')."

\n"; + $Str .= "

\n".''; + $Str .= &mt('Disable ID/Student Number Safeguard and Force Change '. + 'of Conflicting IDs (only do if you know what you are doing)'). + "\n

\n"; + $Str .= ''."
\n"; + $Str .= &mt('Note: for large courses, this operation may be time '. + 'consuming'); + $r->print($Str); + 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"); +############################################################### +############################################################### +sub print_upload_manager_form { + my $r=shift; + + my $firstLine; + 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(); + if($ENV{'form.noFirstLine'}){ + $firstLine=shift(@records); + } + my $total=$#records; + my $distotal=$total+1; + my $today=time; + my $halfyear=$today+15552000; + # + # Restore memorized settings + &Apache::loncommon::restore_course_settings + ('enrollment_upload',{ 'username_choice' => 'scalar', # column settings + 'names_choice' => 'scalar', + 'fname_choice' => 'scalar', + 'mname_choice' => 'scalar', + 'lname_choice' => 'scalar', + 'gen_choice' => 'scalar', + 'id_choice' => 'scalar', + 'sec_choice' => 'scalar', + 'ipwd_choice' => 'scalar', + 'email_choice' => 'scalar', + }); + # + # Determine kerberos parameters as appropriate + my $defdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); + # + &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom); + my $i; + my $keyfields; + if ($total>=0) { + my @field= + (['username',&mt('Username'), $ENV{'form.username_choice'}], + ['names',&mt('Last Name, First Names'),$ENV{'form.names_choice'}], + ['fname',&mt('First Name'), $ENV{'form.fname_choice'}], + ['mname',&mt('Middle Names/Initials'),$ENV{'form.mname_choice'}], + ['lname',&mt('Last Name'), $ENV{'form.lname_choice'}], + ['gen', &mt('Generation'), $ENV{'form.gen_choice'}], + ['id', &mt('ID/Student Number'),$ENV{'form.id_choice'}], + ['sec', &mt('Group/Section'), $ENV{'form.sec_choice'}], + ['ipwd', &mt('Initial Password'),$ENV{'form.ipwd_choice'}], + ['email',&mt('EMail Address'), $ENV{'form.email_choice'}]); + if ($ENV{'form.upfile_associate'} eq 'reverse') { + &Apache::loncommon::csv_print_samples($r,\@records); + $i=&Apache::loncommon::csv_print_select_table($r,\@records, + \@field); + foreach (@field) { + $keyfields.=$_->[0].','; + } + chop($keyfields); + } else { + unshift(@field,['none','']); + $i=&Apache::loncommon::csv_samples_select_table($r,\@records, + \@field); + my %sone=&Apache::loncommon::record_sep($records[0]); + $keyfields=join(',',sort(keys(%sone))); + } + } + &print_upload_manager_footer($r,$i,$keyfields,$defdom,$today,$halfyear); +} +############################################################### +############################################################### +sub enroll_single_student { + my $r=shift; + # Remove non alphanumeric values from section + $ENV{'form.csec'}=~s/\W//g; + # + # 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)); } - function dateset() { - if (document.studentform.pres_marker.value=='end') { - document.studentform.enddate.value= - document.studentform.pres_value.value; + $r->print('

'.&mt('Enrolling Student').'

'); + $r->print('

'.&mt('Enrolling').' '.$ENV{'form.cuname'}." \@ ". + $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_library_servers($domain); + if (! exists($home_servers{$desiredhost})) { + $r->print(''.&mt('Error').':'. + &mt('Invalid home server specified')); + return; + } + } + $r->print(" ".&mt('with server')." $desiredhost :") if (defined($desiredhost)); + # End of home server selection logic + 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'; + $genpwd=$ENV{'form.intarg'}; + } elsif ($ENV{'form.login'} eq 'loc') { + $amode='localauth'; + $genpwd=$ENV{'form.locarg'}; + if (!$genpwd) { $genpwd=" "; } + } + 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("

".&mt('If active, the new role will be available when the student next logs in to LON-CAPA.')."

"); + } else { + $r->print(&mt('unable to enroll').": ".$login_result); + } + } else { + $r->print('

'.&mt('ERROR').' '); + if ($amode =~ /^krb/) { + $r->print(&mt('Missing Kerberos domain information.').' '); + } else { + $r->print(&mt('Invalid login mode or password.').' '); + } + $r->print(''.&mt('Unable to enroll').' '.$ENV{'form.cuname'}.'.

'); + } + } else { + $r->print(&mt('Invalid username or domain')); + } +} + +sub setup_date_selectors { + my ($starttime,$endtime,$mode) = @_; + if (! defined($starttime)) { + $starttime = time; + unless ($mode eq 'createcourse') { + 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 + unless ($mode eq 'createcourse') { + if (exists($ENV{'course.'.$ENV{'request.course.id'}. + '.default_enrollment_end_date'})) { + $endtime = $ENV{'course.'.$ENV{'request.course.id'}. + '.default_enrollment_end_date'}; + } } - if (document.studentform.pres_marker.value=='start') { - document.studentform.startdate.value= - document.studentform.pres_value.value; + } + my $startdateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'startdate', + $starttime); + my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'enddate', + $endtime); + if ($mode eq 'createcourse') { + $startdateform = &Apache::lonhtmlcommon::date_setter('ccrs', + 'startdate', + $starttime); + $enddateform = &Apache::lonhtmlcommon::date_setter('ccrs', + '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,$mode) = @_; + my ($startform,$endform)=&setup_date_selectors($starttime,$endtime,$mode); + my $dateDefault = ''. + ' '. + &mt('make these dates the default for future enrollment'); + if ($mode eq 'createcourse') { + $dateDefault = ' '; + } + my $perpetual = ''; + my $result = ''; + $result .= "\n"; + $result .= ''. + ''. + ''."\n"; + $result .= ''. + ''. + ''."\n"; + $result .= "
'.&mt('Starting Date').''.$startform.''.$dateDefault.'
'.&mt('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 .= &mt('Unable to set default dates for course').":".$put_result. + '
'; + } + return $result; +} + +## +## Single student enrollment routines (some of them) +## +sub get_student_username_domain_form { + my $r = shift; + my $domform = &Apache::loncommon::select_dom_form + ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'},'cudomain',0); + my %lt=&Apache::lonlocal::texthash( + 'eos' => "Enroll One Student", + 'usr' => "Username", + 'dom' => "Domain", + 'been' => "Begin Enrollment", + ); + $r->print(< + +

$lt{'eos'}

+ + + + + + + +
$lt{'usr'}:
$lt{'dom'}:$domform
  + +
+END + return; +} + +sub print_enroll_single_student_form { + my $r=shift; + $r->print("

".&mt('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; + } + # + my $user_data_html = ''; + my $javascript_validations = ''; + if ($new_user) { + my $defdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; + # Set up authentication forms + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($domain); + $javascript_validations=&javascript_validations('auth',$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"; + # + # + my %lt=&Apache::lonlocal::texthash( + 'udf' => "User Data for", + 'fn' => "First Name", + 'mn' => "Middle Name", + 'ln' => "Last Name", + 'gen' => "Generation", + 'hs' => "Home Server", + 'pswd' => "Password", + 'psam' => "Please select an authentication mechanism", + ); + $user_data_html = <$lt{'udf'} $username\@$domain + + + + + + + + + + + +
$lt{'fn'}:
$lt{'mn'}:
$lt{'ln'}:
$lt{'gen'}:
$lt{'hs'}:$homeserver_form
+

$lt{'pswd'}

+$lt{'psam'} + +

+$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('noauth'); + my %lt=&Apache::lonlocal::texthash( + 'udf' => "User Data for", + 'fn' => "First Name", + 'mn' => "Middle Name", + 'ln' => "Last Name", + 'gen' => "Generation", + ); + $user_data_html = <$lt{'udf'} $username\@$domain + +
+ + + + + + + + +
$lt{'fn'}: + +
$lt{'mn'}: + +
$lt{'ln'}: + +
$lt{'gen'}: + +
+END } + my $date_table = &date_setting_table(); + # Print it all out + my %lt=&Apache::lonlocal::texthash( + 'cd' => "Course Data", + 'gs' => "Group/Section", + 'idsn' => "ID/Student Number", + 'disn' => "Disable ID/Student Number Safeguard and Force Change of Conflicting IDs (only do if you know what you are doing)", + 'eas' => "Enroll as student", + ); + $r->print(< + + + + - -ENDPICK - my @sone; my @stwo; my @sthree; my $nfields=0; - if ($#lines>=0) { - $lines[0]=~s/^$remove//; - $lines[0]=~s/$remove$//; - @sone=split(/$separator/,$lines[0]); - $nfields=$#sone; - if ($#lines>=1) { - $lines[1]=~s/^$remove//; - $lines[1]=~s/$remove$//; - @stwo=split(/$separator/,$lines[1]); - $nfields=$#stwo; - } - if ($#lines>=2) { - $lines[2]=~s/^$remove//; - $lines[2]=~s/$remove$//; - @sthree=split(/$separator/,$lines[2]); - $nfields=$#sthree; - } - my $i; - for ($i=0;$i<=$nfields;$i++) { - $r->print(''); - } - } - $r->print(<$lt{'cd'} + +

$lt{'gs'}: +

+$date_table +

+

$lt{'idsn'}

+

+$lt{'idsn'}: +

+ +$lt{'disn'} +

+ +

+END + return; +} + +# ========================================================= Menu Phase Two Drop +sub print_drop_menu { + my $r=shift; + $r->print("

".&mt('Drop Students')."

"); + my $cid=$ENV{'request.course.id'}; + my ($classlist,$keylist) = &Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print(&mt('There are no students currently enrolled.')."\n"); + return; + } + # Print out the available choices + &show_drop_list($r,$classlist,$keylist); + return; +} + +# ============================================== 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'); + my $cid=$ENV{'request.course.id'}; + my $cdom=$ENV{'course.'.$cid.'.domain'}; + my $cnum=$ENV{'course.'.$cid.'.num'}; +# -------------------------------------------------------- Get course personnel + my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum); + $r->print('
FieldSamples
'); - if (defined($sone[$i])) { - $r->print($sone[$i]."
\n"); - } - if (defined($stwo[$i])) { - $r->print($stwo[$i]."
\n"); - } - if (defined($sthree[$i])) { - $r->print($sthree[$i]."
\n"); - } - $r->print('
'); + foreach (sort keys %coursepersonnel) { + $r->print(''); + } + $r->print('
'.$_.''); + foreach (split(/\,/,$coursepersonnel{$_})) { + my ($puname,$pudom)=split(/\:/,$_); + $r->print(' '.&Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($puname, + $pudom),$puname,$pudom)); + } + $r->print('
'); +# --------------------------------------------------------------- Student roles + my $CCL=&mt('Current Class List'); + $r->print(< + +

+$CCL +      +END + if ($ENV{'form.action'} ne 'modifystudent') { + my %lt=&Apache::lonlocal::texthash( + 'ef' => "Excel format", + 'ss' => "Student Status", + ); + $r->print(< +CSV format +         +$lt{'ef'} + +      +$lt{'ss'}: +END + } + $r->print($status_select."

\n"); + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print(&mt('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(&mt('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(&mt('Select a user name to view the users personal page.')); + } elsif ($linkto eq 'modify') { + $r->print(&mt('Select a user name to modify the students information')); + } + my %lt=&Apache::lonlocal::texthash( + 'usrn' => "username", + 'dom' => "domain", + 'sn' => "student name", + 'sec' => "section", + ); + $r->print(< + + +

+ + + +END + } elsif ($mode eq 'csv') { + if($statusmode eq 'Expired') { + $r->print(&mt('Students with expired roles')); + } + if ($statusmode eq 'Any') { + $r->print('"'.join('","',(&mt("username"),&mt("domain"),"ID", + &mt("student name"),&mt("section"),&mt("status"))). + '"'."\n"); + } else { + $r->print('"'.join('","',(&mt("username"),&mt("domain"),"ID", + &mt("student name"),&mt("section"))).'"'."\n"); + } + } 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('
+ $lt{'usrn'} + + $lt{'dom'} + + ID + + $lt{'sn'} + + $lt{'sec'} +
\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('

'. + &mt('Your Excel spreadsheet').' '.&mt('is ready for download').'.

'."\n"); + } +} + + +# +# 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(''.&mt('Error').''. + '

'. + &mt('Unable to retrieve environment data for').' '.$sname. + &mt('in domain').' '.$sdom.'

'. + &mt('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); + if ($starttime =~ /^error/) { + $r->print('

'&mt('Error').'

'); + $r->print('

'.$starttime.'

'); + return; + } + # 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 + my %lt=&Apache::lonlocal::texthash( + 'mef' => "Modify Enrollment for", + 'odcc' => "Only domain coordinators can change a users password.", + 'sn' => "Student Name", + 'fn' => "First", + 'mn' => "Middle", + 'ln' => "Last", + 'gen' => "Generation", + 'sid' => "Student ID", + 'disn' => "Disable ID/Student Number Safeguard and Force Change of Conflicting IDs (only do if you know what you are doing)", + 'sec' => "Section", + 'sm' => "Submit Modifications", + ); + $r->print(< + +$lt{'odcc'} + +

+ + + + + + + +

$lt{'mef'} $info{'firstname'} $info{'middlename'} +$info{'lastname'} $info{'generation'}, $sname\@$sdom

+

+$lt{'sn'} + + +
$lt{'fn'}$lt{'mn'}$lt{'ln'}$lt{'gen'}
+ + + +
- -

Login Type

- -Kerberos authenticated with domain -

- -Internally authenticated (with initial password -) -

LON-CAPA Domain for Students

-LON-CAPA domain:

-

Starting and Ending Dates

- - - - - -Set Starting Date

- -Set Ending Date

-

Full Update

- Full update -(also dropping students)

-
-Note: for large courses, this operation might be time consuming. -ENDPICK - } elsif ($ENV{'form.enroll'}) { - } elsif ($ENV{'form.drop'}) { - } - } -# ----------------------------------------------------------------- Phase three - if ($ENV{'form.phase'} eq 'three') { - if ($ENV{'form.datatoken'}) { - my $separator=''; - my $remove=''; - if ($ENV{'form.upfiletype'} eq 'csv') { - $separator='\"\,\s*\"'; - $remove='"'; - } elsif ($ENV{'form.upfiletype'} eq 'space') { - $separator='\s+'; - } elsif ($ENV{'form.upfiletype'} eq 'tab') { - $separator='\t+'; - } elsif ($ENV{'form.upfiletype'} eq 'xml') { - } - my %fields=(); - for (my $i=0;$i<=$ENV{'form.nfields'};$i++) { - $fields{$ENV{'form.f'.$i}}=$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'}; - } - } - unless (($domain=~/\W/) || ($amode eq '')) { - $r->print('

Enrolling Students

'); - my $count=0; - my $flushc=0; - my %student=(); -# ----------------------------------------------------------- Get new classlist - my @studentdata=(); - { - my $fh; - if ($fh=Apache::File->new($r->dir_config('lonDaemons'). - '/tmp/'.$ENV{'form.datatoken'}.'.tmp')) { - @studentdata=<$fh>; +

+$lt{'sid'}: +

+ +$lt{'disn'} +

+$lt{'sec'}: +

+

$date_table

+ + +END + return; +} + +# +# modify a single students section +# +sub modify_single_student { + my $r = shift; + # + # Remove non alphanumeric values from the section + $ENV{'form.section'} =~ s/\W//g; + # + # 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(&mt('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("".&mt('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 + my %lt=&Apache::lonlocal::texthash( + 'mdu' => "Modifying data for user", + 'si' => "Student Information", + 'fd' => "Field", + 'ov' => "Old Value", + 'nv' => "New Value", + 'fn' => "First name", + 'mn' => "Middle name", + 'ln' => "Last name", + 'gen' => "Generation", + 'sec' => "Section", + 'ri' => "Role Information", + 'st' => "Start Time", + 'et' => "End Time", + ); + $r->print(<$lt{'mdu'} $slogin \@ $sdom +

$lt{'si'}

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$lt{'fd'} $lt{'ov'} $lt{'nv'}
$lt{'fn'} $old{'firstname'} $firstname
$lt{'mn'} $old{'middlename'} $middlename
$lt{'ln'} $old{'lastname'} $lastname
$lt{'gen'} $old{'generation'} $generation
ID $old{'id'} $sid
$lt{'sec'} $old{'section'} $section
+

$lt{'ri'}

+ + + +
$lt{'st'}: $displayable_starttime
$lt{'et'}: $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(&mt('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(&mt('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(&mt('An error occurred during the attempt to change the role information for this student.')."
". + &mt('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(&mt('Student information updated successfully.')."
". + &mt('The student must log out and log in again to see these changes.')); + } + my $Masd=&mt('Modify another students data'); + $r->print(<

+ + + +$Masd + +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 ('error'.$tmp) 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); +} + +################################################# +################################################# + +=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,$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 + + if ($nosort) { + my %lt=&Apache::lonlocal::texthash( + 'usrn' => "username", + 'dom' => "domain", + 'sn' => "student name", + 'sec' => "section", + ); + $r->print(< + +   + $lt{'usrn'} + $lt{'dom'} + ID + $lt{'sn'} + $lt{'sec'} + +END + + } else { + my %lt=&Apache::lonlocal::texthash( + 'usrn' => "username", + 'dom' => "domain", + 'sn' => "student name", + 'sec' => "section", + ); + $r->print(< +  + + $lt{'usrn'} + + $lt{'dom'} + + ID + + $lt{'sn'} + + $lt{'sec'} + + +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('
'); + my %lt=&Apache::lonlocal::texthash( + 'dp' => "Drop Students", + 'ca' => "check all", + 'ua' => "uncheck all", + ); + $r->print(<<"END"); +

+   + +

+END + return; +} + +# +# Print out the initial form to get the courselist file +# +sub print_first_courselist_upload_form { + my $r=shift; + my $str; + $str = ''; + $str .= ''; + $str .= ''; + $str .= "

".&mt('Upload a class list')."

\n"; + $str .= &Apache::loncommon::upfile_select_html(); + $str .= "

\n"; + $str .= ''."\n"; + $str .= ' '. + &mt('Ignore First Line')."

\n"; + $str .= &Apache::loncommon::help_open_topic("Course_Create_Class_List", + &mt("How do I create a class list from a spreadsheet")). + "
\n"; + $str .= &Apache::loncommon::help_open_topic("Course_Convert_To_CSV", + &mt("How do I create a CSV file from a spreadsheet")). + "
\n"; + $str .= "\n\n"; + $r->print($str); + return; +} + +# ================================================= 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(); + if($ENV{'form.noFirstLine'}){shift(@studentdata);} + 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]; + } + } + # + # Store the field choices away + foreach my $field (qw/username names + fname mname lname gen id sec ipwd email/) { + $ENV{'form.'.$field.'_choice'}=$fields{$field}; + } + &Apache::loncommon::store_course_settings('enrollment_upload', + { 'username_choice' => 'scalar', + 'names_choice' => 'scalar', + 'fname_choice' => 'scalar', + 'mname_choice' => 'scalar', + 'lname_choice' => 'scalar', + 'gen_choice' => 'scalar', + 'id_choice' => 'scalar', + 'sec_choice' => 'scalar', + 'ipwd_choice' => 'scalar', + 'email_choice' => 'scalar' }); + + # + 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(''.&mt('Error').''. + &mt('Invalid home server specified')); + $r->print("\n\n"); + 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'}; + } + } + if ($amode =~ /^krb/) { + if (! defined($genpwd) || $genpwd eq '') { + $r->print(''. + &mt('Unable to enroll students').' '. + &mt('No Kerberos domain was specified.').'

'); + $amode = ''; # This causes the loop below to be skipped + } + } + unless (($domain=~/\W/) || ($amode eq '')) { + ####################################### + ## Enroll Students ## + ####################################### + $r->print('

'.&mt('Enrolling Students')."

\n

\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'}}; + } } - } -# --------------------------------------------------------- Enroll new students - map { - my $line=$_; - chomp($line); - $line=~s/^$remove//; - $line=~s/$remove$//; - my @entries=split(/$separator/,$line); - 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: '. - $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) { - my $reply=&Apache::lonnet::modifystudent( - $domain,$username,$id,$amode,$password, - $fname,$mname,$lname,$gen,$sec,$enddate,$startdate); - unless ($reply eq 'ok') { - $r->print( - "

Error enrolling $username: $reply

"); - } else { + if ($entries{$fields{'username'}}=~/\W/) { + $r->print('
'. + &mt('[_1]: Unacceptable username for user [_2] [_3] [_4] [_5]', + $entries{$fields{'username'}},$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'}}; + } + } + # remove non alphanumeric values from section + $sec =~ s/\W//g; + # 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 || $ENV{'form.login'} eq 'loc') { + &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('
'. + &mt('[_1]: Unable to enroll: [_2]',$username,$reply)); + } else { $count++; $flushc++; $student{$username}=1; $r->print('. '); @@ -477,61 +1973,212 @@ ENDPICK $flushc=0; } } - } else { - $r->print( - "

No password for $username

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

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

Dropping Students

'); -# ------------------------------------------------------- Get current classlist - 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\:/) { - map { - 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; - } - } split(/\&/,$classlst); + } else { + $r->print('
'. + &mt('[_1]: Unable to enroll. No password specified.',$username) + ); + } + } + } + } # end of foreach (@studentdata) + $r->print("

\n

\n".&mt('Processed [_1] student(s).',$count). + "

\n"); + $r->print("

\n". + &mt('If active, the new role will be available when the '. + 'students next log in to LON-CAPA.')."

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

'.&mt('Dropping Students')."

\n"); + # Get current classlist + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print(&mt('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 +} - } else { - $r->print( - '

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

'); - } - } -# ------------------------------------------------------------------------ Done - } +# ================================================================== Phase four +sub drop_student_list { + my $r=shift; + my $count=0; + 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(&mt('Dropped [_1]',$uname.'@'.$udom).'
'); + $count++; + } else { + $r->print( + &mt('Error dropping [_1]:[_2]',$uname.'@'.$udom,$result). + '
'); } - } -# ------------------------------------------------------------------------- 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; + } + $r->print('

'.&mt('Dropped [_1] student(s).',$count).'

'); + $r->print('

'.&mt('Re-enrollment will re-activate data.')) if ($count); } -1; -__END__ +################################################################### +################################################################### + +=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 + +################################################################### +################################################################### +sub handler { + my $r=shift; + if ($r->header_only) { + &Apache::loncommon::content_type($r,'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 + &Apache::loncommon::content_type($r,'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__