--- loncom/interface/Attic/londropadd.pm 2002/05/06 17:48:57 1.41 +++ loncom/interface/Attic/londropadd.pm 2004/09/13 16:21:30 1.118 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# $Id: londropadd.pm,v 1.41 2002/05/06 17:48:57 matthew Exp $ +# $Id: londropadd.pm,v 1.118 2004/09/13 16:21:30 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,55 +25,40 @@ # # http://www.lon-capa.org/ # -# (Handler to set parameters for assessments # -# (Handler to resolve ambiguous file locations -# -# (TeX Content Handler -# -# YEAR=2000 -# 05/29/00,05/30,10/11 Gerd Kortemeyer) -# -# 10/11,10/12,10/16 Gerd Kortemeyer) -# -# 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28, -# 12/08,12/12 Gerd Kortemeyer) -# -# 12/26,12/27,12/28, -# YEAR=2001 -# 01/01/01,01/15,02/10,02/13,02/14,02/22 Gerd Kortemeyer -# 8/6 Scott Harrison -# Guy Albertelli -# 9/25 Gerd Kortemeyer -# 12/19 Guy Albertelli -# YEAR=2002 -# 1/4 Gerd Kortemeyer +############################################################### +############################################################## package Apache::londropadd; use strict; use Apache::lonnet(); use Apache::loncommon(); +use Apache::lonhtmlcommon(); use Apache::Constants qw(:common :http REDIRECT); +use Spreadsheet::WriteExcel; +use Apache::lonstathelpers(); +use Apache::lonlocal; -# ================================================================ Print header - +############################################################### +############################################################### sub header { + my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager'); + my $title = &mt('LON-CAPA Enrollment Manager'); return(< -LON-CAPA Enrollment Manager +$title - - -

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

-

Enrollment Manager

+$bodytag
ENDHEAD } -# =========== Drop student from all sections of a course, except optional $csec +############################################################### +############################################################### +# 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 @@ -92,12 +77,16 @@ sub modifystudent { # We are in this course my $section=$1; $section='' if ($course eq $courseid.'_st'); - if ( ((!$section) && (!$csec)) || ($section ne $csec) ) { + 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 - ($udom,$unam,'','','','','','','', + # dom name id mode pass f m l g + ($udom,$unam,'', '', '',undef,undef,undef,undef, $section,time,undef,undef,$desiredhost); $result .= $reply.':'; } @@ -105,14 +94,16 @@ sub modifystudent { } } if ($result eq '') { - $result eq 'Unable to find section for this student'; + $result = 'Unable to find section for this student'; } else { $result =~ s/(ok:)+/ok/g; } return $result; } -# ============ build a domain and server selection form +############################################################### +############################################################### +# build a domain and server selection form sub domain_form { my ($defdom) = @_; # Set up domain and server selection forms @@ -129,7 +120,7 @@ sub domain_form { $select_menus{$dom}->{'default'}= 'default'; $select_menus{$dom}->{'select2'}->{'default'} = 'default'; # Now build up the other items in the second menu - my %servers = &Apache::loncommon::get_home_servers($dom); + my %servers = &Apache::loncommon::get_library_servers($dom); foreach my $server (keys(%servers)) { $select_menus{$dom}->{'select2'}->{$server} = "$server $servers{$server}"; @@ -141,89 +132,228 @@ sub domain_form { return $result; } -# ============================================================== Menu Phase One -sub menu_phase_one { +############################################################### +############################################################### +# Menu Phase One +sub print_main_menu { my $r=shift; - my $upfile_select=&Apache::loncommon::upfile_select_html(); - $r->print(< -
-

Upload a courselist

-$upfile_select -

-

-

Enroll a single student

-

-
-

Classlist

-

-

-
-

Drop students

-

-ENDUPFORM + 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($_); + } + + $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'} +

+END + my ($cdom,$cnum) = split/_/,$ENV{'request.course.id'}; + if (&Apache::lonnet::auto_run($cnum,$cdom) ) { + $r->print(< + $Text{'populate'} + +END + } } -sub phase_two_header { +############################################################### +############################################################### +sub hidden_input { + my ($name,$value) = @_; + return ''."\n"; +} + +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=&phase_two_javascript_reverse_associate(); + $javascript=&upload_manager_javascript_reverse_associate(); } else { - $javascript=&phase_two_javascript_forward_associate(); + $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 + # + # Deal with restored settings + my $password_choice = ''; + if (exists($ENV{'form.ipwd_choice'}) && + $ENV{'form.ipwd_choice'} ne '') { + # If a column was specified for password, assume it is for an + # internal password. This is a bug waiting to be filed (could be + # local or krb auth instead of internal) but I do not have the + # time to mess around with this now. + $password_choice = 'int'; + } + # + my $javascript_validations=&javascript_validations('auth',$krbdefdom, + $password_choice); + my $checked=(($ENV{'form.noFirstLine'})?' checked="1"':''); + $r->print('

'.&mt('Uploading Class List')."

\n". + "
\n". + '

'.&mt('Identify fields')."

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

\n". + &mt('Total number of records found in file: [_1].',$distotal). + "\n". + "

\n"); + $r->print(&mt('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 enroll students in your class.')."
\n"); + $r->print(&hidden_input('action','upload'). + &hidden_input('state','got_file'). + &hidden_input('associate',''). + &hidden_input('datatoken',$datatoken). + &hidden_input('fileupload',$ENV{'form.fileupload'}). + &hidden_input('upfiletype',$ENV{'form.upfiletype'}). + &hidden_input('upfile_associate',$ENV{'form.upfile_associate'})); + $r->print(''); + $r->print(''. + &mt('Ignore First Line')); + $r->print("
\n". + ''); } +############################################################### +############################################################### sub javascript_validations { - my ($krbdefdom)=@_; - my %param = ( formname => 'studentform', - kerb_def_dom => $krbdefdom ); - my $authheader = &Apache::loncommon::authform_header(%param); - return (< '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 =(<=3) && @@ -338,6 +483,8 @@ function flip(vf,tf) { } } } + // 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) { @@ -345,6 +492,8 @@ function flip(vf,tf) { } } } + // If we set the password, make the password form below correspond to + // the new value. if (nw==9) { changed_radio('int',document.studentform); set_auth_radio_buttons('int',document.studentform); @@ -366,7 +515,9 @@ function clearpwd(vf) { ENDPICK } -sub phase_two_javascript_reverse_associate { +############################################################### +############################################################### +sub upload_manager_javascript_reverse_associate { return(< 'document.studentform'); + + 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); - $r->print(< - - -

Login Type

-

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

-

-$krbform -

-

-$intform -

-

-$locform -

-

LON-CAPA Domain for Students

-LON-CAPA domain: $domform

-

Starting and Ending Dates

- - - - - -Set Starting Date

- -Set Ending Date

-

Full Update

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

-

ID/Student Number

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

-
-Note: for large courses, this operation might be time consuming. -ENDPICK -} - -# ======================================================= Menu Phase Two Upload -sub menu_phase_two_upload { + my $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; +} + +############################################################### +############################################################### +sub print_upload_manager_form { my $r=shift; + my $firstLine; my $datatoken; if (!$ENV{'form.datatoken'}) { - $datatoken=&Apache::loncommon::upfile_store($r); + $datatoken=&Apache::loncommon::upfile_store($r); } else { - $datatoken=$ENV{'form.datatoken'}; - &Apache::loncommon::load_tmp_file($r); + $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; - $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); + # + # 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 @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']); + 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,\@d); - foreach (@d) { $keyfields.=$_->[0].','; } + $i=&Apache::loncommon::csv_print_select_table($r,\@records, + \@field); + foreach (@field) { + $keyfields.=$_->[0].','; + } chop($keyfields); } else { - unshift(@d,['none','']); - $i=&Apache::loncommon::csv_samples_select_table($r,\@records,\@d); + 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))); } } - &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; - $r->print('

Enrolling Student

'); - $r->print('

Enrolling '.$ENV{'form.cuname'}." in domain ". + # 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 separate 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('

'.&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/)) { @@ -526,19 +724,20 @@ sub enroll_single_student { if (lc($desiredhost) eq 'default') { $desiredhost = undef; } else { - my %home_servers = &Apache::loncommon::get_home_servers($domain); + my %home_servers =&Apache::loncommon::get_library_servers($domain); if (! exists($home_servers{$desiredhost})) { - $r->print('Error:'. - 'Invalid home server specified'); + $r->print(''.&mt('Error').':'. + &mt('Invalid home server specified')); return; } } - $r->print(" with server $desiredhost :") if (defined($desiredhost)); + $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='krb4'; + $amode='krb'; + $amode.=$ENV{'form.krbver'}; $genpwd=$ENV{'form.krbarg'}; } elsif ($ENV{'form.login'} eq 'int') { $amode='internal'; @@ -551,46 +750,300 @@ sub enroll_single_student { 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); - $r->print(&Apache::lonnet::modifystudent( - $ENV{'form.lcdomain'},$ENV{'form.cuname'}, - $ENV{'form.cstid'},$amode,$genpwd, - $ENV{'form.cfirst'},$ENV{'form.cmiddle'}, - $ENV{'form.clast'},$ENV{'form.cgen'}, - $ENV{'form.csec'},$ENV{'form.enddate'}, - $ENV{'form.startdate'},$ENV{'form.forceid'}, - $desiredhost)); + 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('

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

'); - } + $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('Invalid username or domain'); + $r->print(&mt('Invalid username or domain')); } } -# ======================================================= Menu Phase Two Enroll -sub menu_phase_two_enroll { +sub setup_date_selectors { + my ($starttime,$endtime,$mode) = @_; + if (! defined($starttime)) { + $starttime = time; + unless ($mode eq 'create_enrolldates' || $mode eq 'create_defaultdates') { + 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'}; + } + } + } + my $startdateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'startdate', + $starttime); + my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'enddate', + $endtime); + if ($mode eq 'create_enrolldates') { + $startdateform = &Apache::lonhtmlcommon::date_setter('ccrs', + 'startenroll', + $starttime); + $enddateform = &Apache::lonhtmlcommon::date_setter('ccrs', + 'endenroll', + $endtime); + } + if ($mode eq 'create_defaultdates') { + $startdateform = &Apache::lonhtmlcommon::date_setter('ccrs', + 'startaccess', + $starttime); + $enddateform = &Apache::lonhtmlcommon::date_setter('ccrs', + 'endaccess', + $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 'create_enrolldates' || $mode eq 'create_defaultdates') { + $dateDefault = ' '; + } + my $perpetual = ''; + if ($mode eq 'create_enrolldates') { + $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("

Enroll One Student

"); - my ($krbdefdom) = $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; - $krbdefdom=~tr/a-z/A-Z/; - my $today = time; - my $halfyear = $today+15552000; - my $defdom=$r->dir_config('lonDefDomain'); - my $javascript_validations=&javascript_validations($krbdefdom); - # Set up authentication forms - my %param = ( formname => 'document.studentform'); - my $krbform = &Apache::loncommon::authform_kerberos(%param); - my $intform = &Apache::loncommon::authform_internal(%param); - my $locform = &Apache::loncommon::authform_local(%param); - # Set up domain selection form - my $domform = &domain_form($defdom); - # Print it all out - $r->print(<print("

".&mt('Enroll One Student')."

"); + # + my $username = $ENV{'form.cuname'}; + my $domain = $ENV{'form.cudomain'}; + $username=~s/[\W|_]//gs; + $domain=~s/[\W|_]//gs; + 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(< + + + -

Personal Data

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

ID/Student Number:

- -

Group/Section:

- -

Login Data

-

Username:

-

Domain: $domform

-

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

-$krbform -

-$intform -

-$locform -

-

Starting and Ending Dates

- - - - - -

-Set Starting Date -

-Set Ending Date + +$user_data_html + +

$lt{'cd'}

+ +

$lt{'gs'}: +

+$date_table +

+

$lt{'idsn'}

+

+$lt{'idsn'}:

-

ID/Student Number

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

-
- +$lt{'disn'} +

+

-ENDSENROLL -} - -# =================================================== get the current classlist -sub get_current_classlist { - my ($domain,$identifier) = @_; - # domain is the domain the class is being run in - # identifier is the internal, unique identifier for the class. - my %currentlist=(); - my $now=time; - my %results=&Apache::lonnet::dump('classlist',$domain,$identifier); - my ($tmp) = keys(%results); - if ($tmp !~ /^(con_lost|error|no_such_host)/i) { - foreach my $student (keys(%results)) { - # Extract the start and end dates - my ($end,$start)=split(/\:/,$results{$student}); - # If the class isn't over, put it in the list - unless (($end) && ($now>$end)) { - $currentlist{$student}=1; - } - } - return (undef,%currentlist); - } else { - $tmp =~ s/^error://; - return ($tmp,undef); - } +END + return; } # ========================================================= Menu Phase Two Drop -sub menu_phase_two_drop { +sub print_drop_menu { my $r=shift; - $r->print("

Drop Students

"); + $r->print("

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

"); my $cid=$ENV{'request.course.id'}; - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'},$ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - if ($error =~ /^No such file or directory/) { - $r->print("There are no students currently enrolled.\n"); - } else { - $r->print("
ERROR:$error
"); - } - } elsif (!defined(%currentlist)) { - $r->print("There are no students currently enrolled.\n"); - } else { - # Print out the available choices - &show_drop_list($r,%currentlist); + 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 menu_phase_two_view { - my $r=shift; - $r->print("

Current Classlist

"); +sub print_html_classlist { + my ($r,$mode) = @_; + 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'}); my $cid=$ENV{'request.course.id'}; - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'},$ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - if ($error =~ /^No such file or directory/) { - $r->print("There are no students currently enrolled.\n"); - } else { - $r->print("
ERROR:$error
"); + my $cdom=$ENV{'course.'.$cid.'.domain'}; + my $cnum=$ENV{'course.'.$cid.'.num'}; + # + # List course personnel + my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum); + # + if (! defined($ENV{'form.output'}) || + $ENV{'form.output'} !~ /^(csv|excel|html)$/ ) { + $ENV{'form.output'} = 'html'; + } + # + $r->print('
'); + foreach my $role (sort keys %coursepersonnel) { + next if ($role =~ /^\s*$/); + $r->print(''); + } + $r->print('
'.$role.''); + foreach my $user (split(',',$coursepersonnel{$role})) { + my ($puname,$pudom)=split(':',$user); + $r->print(' '.&Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($puname, + $pudom), + $puname,$pudom)); + } + $r->print('
'); + # + # Interface output + $r->print(''); + $r->print("

\n"); + if ($ENV{'form.action'} ne 'modifystudent') { + my %lt=&Apache::lonlocal::texthash('csv' => "CSV", + 'excel' => "Excel", + 'html' => 'HTML'); + my $output_selector = ''; + $r->print(&mt('Output Format: [_1]',$output_selector).(' 'x3)); + } + $r->print(&mt('Student Status: [_1]',$status_select)."\n"); + $r->print(''. + "\n

\n"); + # + # Print the classlist + $r->print('

'.&mt('Current Class List').'

'); + 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 - &show_class_list($r,'view',%currentlist); - } -} - -# ============================================== view classlist -sub menu_phase_two_viewcsv { - my $r=shift; - my $cid=$ENV{'request.course.id'}; - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'},$ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - if ($error =~ /^No such file or directory/) { - $r->print("There are no students currently enrolled.\n"); + if ($ENV{'form.action'} eq 'modifystudent') { + &show_class_list($r,'view','modify', + $ENV{'form.Status'},$classlist,$keylist); } else { - $r->print("
ERROR:$error
"); + &show_class_list($r,$ENV{'form.output'},'aboutme', + $ENV{'form.Status'},$classlist,$keylist); } - } elsif (!defined(%currentlist)) { - $r->print("There are no students currently enrolled.\n"); - } else { - &show_class_list($r,'csv',%currentlist); } } # =================================================== Show student list to drop sub show_class_list { - my ($r,$mode,%currentlist)=@_; + my ($r,$mode,$linkto,$statusmode,$classlist,$keylist)=@_; my $cid=$ENV{'request.course.id'}; - if ($mode eq 'view') { + # + # Variables for excel output + my ($excel_workbook, $excel_sheet, $excel_filename,$row,$format); + # + # Variables for csv output + my ($CSVfile,$CSVfilename); + # + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id|start|end|type)$/) { + $sortby = 'username'; + } + # Print out header + unless ($mode eq 'autoenroll') { $r->print(< +END + } + $r->print(< +END + if ($mode eq 'html' || $mode eq 'view' || $mode eq 'autoenroll') { + 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", + 'start' => "start date", + 'end' => "end date", + 'type' => "enroll type/action" + ); + unless ($mode eq 'autoenroll') { + $r->print(< + +END + } + $r->print("

- - + + "); + if ($mode eq 'autoenroll') { + $r->print(" + + "); + } else { + $r->print(" + + "); + } + $r->print(< + $lt{'usrn'} + + END } elsif ($mode eq 'csv') { - $r->print(<new('>/home/httpd'.$CSVfilename)) { + $r->log_error("Couldn't open $CSVfilename for output $!"); + $r->print("Problems occured in writing the csv file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator."); + $CSVfile = undef; + } + # + # Write headers and data to file + if($statusmode eq 'Expired') { + print $CSVfile '"'.&mt('Students with expired roles').'"'."\n"; + } + if ($statusmode eq 'Any') { + print $CSVfile '"'.join('","',map { + &Apache::loncommon::csv_translate(&mt($_)) + } ("username","domain","ID","student name", + "section","start date","end date","status")).'"'."\n"; + } else { + print $CSVfile '"'.join('","',map { + &Apache::loncommon::csv_translate(&mt($_)) + } ("username","domain","ID","student name", + "section","start date","end date")).'"'."\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'); + # + $format = &Apache::loncommon::define_excel_formats($excel_workbook); + $excel_sheet = $excel_workbook->addworksheet('classlist'); + # + my $description = 'Class List for '. + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $excel_sheet->write($row++,0,$description,$format->{'h1'}); + # + $excel_sheet->write($row++,0,["username","domain","ID", + "student name","section", + "start date","end date","status"], + $format->{'bold'}); + } + # + # 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)); + my $studentcount = 0; + my $autocount = 0; + my $manualcount = 0; + my $unlockcount = 0; + my $lockcount = 0; + foreach my $student (@Sorted_Students) { + my $sdata = $classlist->{$student}; + my $username = $sdata->[$index{'username'}]; + my $domain = $sdata->[$index{'domain'}]; + my $section = $sdata->[$index{'section'}]; + my $name = $sdata->[$index{'fullname'}]; + my $id = $sdata->[$index{'id'}]; + my $status = $sdata->[$index{'status'}]; + my $start = $sdata->[$index{'start'}]; + my $end = $sdata->[$index{'end'}]; + my $type = $sdata->[$index{'type'}]; + next if (($statusmode ne 'Any') && ($status ne $statusmode)); + if ($mode eq 'view' || $mode eq 'html' || $mode eq 'autoenroll') { + if (! defined($start) || $start == 0) { + $start = &mt('none'); + } else { + $start = &Apache::lonlocal::locallocaltime($start); + } + if (! defined($end) || $end == 0) { + $end = &mt('none'); + } else { + $end = &Apache::lonlocal::locallocaltime($end); + } + $r->print("\n "); + if ($mode eq 'autoenroll') { + my $lockedtype = $sdata->[$index{'lockedtype'}]; + $studentcount++; + my $cellentry; + if ($type eq 'auto') { + $cellentry = ''.&mt('auto').'  Change'; + $autocount ++; + } else { + $cellentry = '
usernamedomainIDstudent namegenerationsection
$lt{'type'}Count + $lt{'dom'} + + ID + + $lt{'sn'} + + $lt{'sec'} + + $lt{'start'} + + $lt{'end'} +
'.&mt('manual').' Change
'; + $manualcount ++; + if ($lockedtype) { + $cellentry .= ' '.&mt('Unlock'); + $unlockcount ++; + } else { + $cellentry .= ' '.&mt('Lock'); + $lockcount ++; + } + $cellentry .= '
'; + } + $r->print("$cellentry\n "); + } else { + $r->print("".(++$studentcount)."\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 + $start + $end + +END + } elsif ($mode eq 'csv') { + next if (! defined($CSVfile)); + # no need to bother with $linkto + if (! defined($start) || $start == 0) { + $start = &mt('none'); + } else { + $start = &Apache::lonlocal::locallocaltime($start); + } + if (! defined($end) || $end == 0) { + $end = &mt('none'); + } else { + $end = &Apache::lonlocal::locallocaltime($end); + } + my @line = (); + foreach ($username,$domain,$id,$name,$section,$start,$end) { + push @line,&Apache::loncommon::csv_translate($_); + } + if ($statusmode eq 'Any') { + push @line,&Apache::loncommon::csv_translate($status); + } + print $CSVfile '"'.join('","',@line).'"'."\n"; + } elsif ($mode eq 'excel') { + $excel_sheet->write($row,0,[$username,$domain,$id, + $name,$section]); + my $col = 5; + foreach my $time ($start,$end) { + $excel_sheet->write($row,$col++, + &Apache::lonstathelpers::calc_serial($time), + $format->{'date'}); + } + $excel_sheet->write($row,$col++,$status); + $row++; + } + } + if ($mode eq 'view' || $mode eq 'html' || $mode eq 'autoenroll') { + $r->print('
'); + } elsif ($mode eq 'excel') { + $excel_workbook->close(); + $r->print('

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

'."\n"); + } elsif ($mode eq 'csv') { + close($CSVfile); + $r->print(''. + &mt('Your CSV file').' is ready for download.'. + "\n"); + $r->rflush(); + } + if ($mode eq 'autoenroll') { + return ($studentcount,$autocount,$manualcount,$lockcount,$unlockcount); + } + return; +} + + +# +# 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 $current_date_description = ''; + my $textdate = ''; + + if (! defined($starttime) || $starttime == 0) { + $current_date_description = &mt('Current Starting Date: not set'). + '
'; + } else { + $current_date_description = + &mt('Current Starting Date: [_1]', + &Apache::lonlocal::locallocaltime($starttime)).'
'; + } + if (! defined($endtime) || $endtime == 0) { + $current_date_description.= &mt('Current Ending Date: not set'). + '
'; + } else { + $current_date_description.= + &mt('Current Ending Date: [_1]', + &Apache::lonlocal::locallocaltime($endtime)).'
'; + + } + 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'}
+ + + +
+

+$lt{'sid'}: +

+ +$lt{'disn'} +

+$lt{'sec'}: +

+

$current_date_description

+

$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; } - foreach (sort keys %currentlist) { - my ($sname,$sdom)=split(/\:/,$_); - my %reply=&Apache::lonnet::idrget($sdom,$sname); - my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid); - my %info=&Apache::lonnet::get('environment', - ['firstname','middlename', - 'lastname','generation'], - $sdom, $sname); - my ($tmp) = keys(%info); - if ($tmp =~ /^(con_lost|error|no_such_host)/i) { - $r->print( ($mode eq 'view' ? - '' :''). - 'Internal error: unable to get environment '. - 'for '.$sname.' in domain '.$sdom. - ( $mode eq 'view' ?'' :'')); - } else { - if ($mode eq 'view') { - $r->print(<<"END"); + 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'}

+ - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$sname$sdom$reply{$sname}$info{'lastname'}, $info{'firstname'} $info{'middlename'}$info{'generation'}$ssec $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 - } elsif ($mode eq 'csv') { - $r->print($sname.','. - $sdom.','. - $reply{$sname}.','. - $info{'lastname'}.','. - $info{'firstname'}.','. - $info{'middlename'}.','. - $info{'generation'}.','. - $ssec."\n"); + 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); } } } - $r->print('
') if ($mode eq 'view'); + 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'}; - $r->print(<<'END'); + 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|start|end)$/) { + $sortby = 'username'; + } + # + my $action = "drop"; + $r->print(< + +

+END + +my %lt=&Apache::lonlocal::texthash('usrn' => "username", + 'dom' => "domain", + 'sn' => "student name", + 'sec' => "section", + 'start' => "start date", + 'end' => "end date", + ); + if ($nosort) { + $r->print(< - usernamedomain -IDstudent namegeneration -section -END - foreach (sort keys %currentlist) { - my ($sname,$sdom)=split(/\:/,$_); - my %reply=&Apache::lonnet::idrget($sdom,$sname); - my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid); - my %info=&Apache::lonnet::get('environment', - ['firstname','middlename', - 'lastname','generation'], - $sdom, $sname); - my ($tmp) = keys(%info); - if ($tmp =~ /^(con_lost|error|no_such_host)/i) { - $r->print(''. - 'Internal error: unable to get environment '. - 'for '.$sname.' in domain '.$sdom.''); - } else { - $r->print(<<"END"); - - $sname - $sdom - $reply{$sname} - $info{'lastname'}, $info{'firstname'} $info{'middlename'} - $info{'generation'} - $ssec +   + $lt{'usrn'} + $lt{'dom'} + ID + $lt{'sn'} + $lt{'sec'} + $lt{'start'} + $lt{'end'} END + + } else { + $r->print(< +  + + $lt{'usrn'} + + $lt{'dom'} + + ID + + $lt{'sn'} + + $lt{'sec'} + + $lt{'start'} + + $lt{'end'} + + +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 $sdata = $classlist->{$student}; + my $username = $sdata->[$index{'username'}]; + my $domain = $sdata->[$index{'domain'}]; + my $section = $sdata->[$index{'section'}]; + my $name = $sdata->[$index{'fullname'}]; + my $id = $sdata->[$index{'id'}]; + my $start = $sdata->[$index{'start'}]; + my $end = $sdata->[$index{'end'}]; + if (! defined($start) || $start == 0) { + $start = &mt('none'); + } else { + $start = &Apache::lonlocal::locallocaltime($start); + } + if (! defined($end) || $end == 0) { + $end = &mt('none'); + } else { + $end = &Apache::lonlocal::locallocaltime($end); } + my $status = $sdata->[$index{'status'}]; + next if ($status ne 'Active'); + # + $r->print(<<"END"); + + + $username + $domain + $id + $name + $section + $start + $end + +END } $r->print('
'); + %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 @@ -883,6 +1970,7 @@ 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=(); @@ -896,20 +1984,39 @@ sub upfile_drop_add { } } # - my $startdate = $ENV{'form.startdate'}; - my $enddate = $ENV{'form.enddate'}; - if ($startdate=~/\D/) { $startdate=''; } - if ($enddate=~/\D/) { $enddate=''; } + # 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_home_servers($domain); + my %home_servers = &Apache::loncommon::get_library_servers($domain); if (! exists($home_servers{$desiredhost})) { - $r->print('Error:'. - 'Invalid home server specified'); + $r->print(''.&mt('Error').''. + &mt('Invalid home server specified')); + $r->print("\n\n"); return; } } @@ -917,7 +2024,8 @@ sub upfile_drop_add { my $amode = ''; my $genpwd = ''; if ($ENV{'form.login'} eq 'krb') { - $amode='krb4'; + $amode='krb'; + $amode.=$ENV{'form.krbver'}; $genpwd=$ENV{'form.krbarg'}; } elsif ($ENV{'form.login'} eq 'int') { $amode='internal'; @@ -930,11 +2038,19 @@ sub upfile_drop_add { $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('

Enrolling Students

'); + $r->print('

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

\n

\n"); my $count=0; my $flushc=0; my %student=(); @@ -963,9 +2079,10 @@ sub upfile_drop_add { } } if ($entries{$fields{'username'}}=~/\W/) { - $r->print('

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

'); + $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=''; @@ -975,6 +2092,8 @@ sub upfile_drop_add { $sec=$entries{$fields{'sec'}}; } } + # remove non alphanumeric values from section + $sec =~ s/\W//g; # determine student id number my $id=''; if (defined($fields{'id'})) { @@ -983,6 +2102,14 @@ sub upfile_drop_add { } $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) { @@ -994,17 +2121,23 @@ sub upfile_drop_add { } } } - if ($password) { + # 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); + $startdate,$ENV{'form.forceid'},$desiredhost, + $email); if ($reply ne 'ok') { - $r->print('

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

'); + $reply =~ s/^error://; + $r->print('
'. + &mt('[_1]: Unable to enroll: [_2]',$username,$reply)); } else { $count++; $flushc++; $student{$username}=1; @@ -1015,38 +2148,40 @@ sub upfile_drop_add { } } } else { - $r->print("

No password for $username

"); + $r->print('
'. + &mt('[_1]: Unable to enroll. No password specified.',$username) + ); } } } } # end of foreach (@studentdata) - $r->print('

Processed Students: '.$count); + $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('

Dropping Students

'); + $r->print('

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

\n"); # Get current classlist - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'}, - $ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - $r->print('
ERROR:$error
'); - } - if (defined(%currentlist)) { - # Drop the students + 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($currentlist{$entries{$fields{'username'}}. + delete($classlist->{$entries{$fields{'username'}}. ':'.$domain}); } } - # Print out list of dropped students - &show_drop_list($r,%currentlist); - } else { - $r->print("There are no students currently enrolled.\n"); + # Print out list of dropped students. + &show_drop_list($r,$classlist,$keylist,'nosort'); } } } # end of unless @@ -1064,85 +2199,189 @@ sub drop_student_list { } 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.' at '.$udom.'
'); + $r->print(&mt('Dropped [_1]',$uname.'@'.$udom).'
'); + $count++; } else { - $r->print('Error dropping '.$uname.' at '.$udom.': '.$result. + $r->print( + &mt('Error dropping [_1]:[_2]',$uname.'@'.$udom,$result). '
'); } - $count++; } - $r->print('

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

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

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

'); + $r->print('

'.&mt('Re-enrollment will re-activate data.')) if ($count); } -# ================================================================ Main Handler +################################################################### +################################################################### + +=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) { - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK; } + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['action','state']); + + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/dropadd", + text=>"Enrollment Manager", + faq=>9,bug=>'Instructor Interface',}); # 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') if (! exists($ENV{'form.viewcsv'})); - $r->send_http_header; - $r->print(&header()) if (! exists($ENV{'form.viewcsv'})); - # Phase one, initial screen - unless ($ENV{'form.phase'}) { - &menu_phase_one($r); - } - # Phase two - if ($ENV{'form.associate'} eq 'Reverse Association') { - $ENV{'form.phase'} = 'two'; - if ( $ENV{'form.upfile_associate'} ne 'reverse' ) { - $ENV{'form.upfile_associate'} = 'reverse'; - } else { - $ENV{'form.upfile_associate'} = 'forward'; - } - } - if ($ENV{'form.phase'} eq 'two') { - if ($ENV{'form.fileupload'}) { - &menu_phase_two_upload($r); - } elsif ($ENV{'form.enroll'}) { - &menu_phase_two_enroll($r); - } elsif ($ENV{'form.drop'}) { - &menu_phase_two_drop($r); - } elsif ($ENV{'form.view'}) { - &menu_phase_two_view($r); - } elsif ($ENV{'form.viewcsv'}) { - &menu_phase_two_viewcsv($r); - } - } - # Phase three - if ($ENV{'form.phase'} eq 'three') { + 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 + # + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['state','action']); + # 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'})) { + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'Enrollment Manager')); + &print_main_menu($r); + } elsif ($ENV{'form.action'} eq 'upload') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/dropadd?action=upload&state=', + text=>"Upload Classlist"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'Upload Classlist','Course_Create_Class_List')); + 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); } - # Phase four - if ($ENV{'form.phase'} eq 'four') { + } elsif ($ENV{'form.action'} eq 'drop') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/dropadd?action=drop', + text=>"Drop Students"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'Drop Students','Course_Drop_Student')); + if (! exists($ENV{'form.state'})) { + &print_drop_menu($r); + } elsif ($ENV{'form.state'} eq 'done') { &drop_student_list($r); + } else { + &print_drop_menu($r); } - # Phase five - if ($ENV{'form.phase'} eq 'five') { + } elsif ($ENV{'form.action'} eq 'enrollstudent') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/dropadd?action=enrollstudent', + text=>"Enroll Student"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'Enroll Student','Course_Add_Student')); + 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') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/dropadd?action=classlist', + text=>"View Classlist"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'View Classlist','Course_View_Class_List')); + if (! exists($ENV{'form.state'})) { + &print_html_classlist($r,undef); + } elsif ($ENV{'form.state'} eq 'csv') { + &print_html_classlist($r,'csv'); + } elsif ($ENV{'form.state'} eq 'excel') { + &print_html_classlist($r,'excel'); + } else { + &print_html_classlist($r,undef); } - # End - $r->print('

') if (! exists($ENV{'form.viewcsv'})); + } elsif ($ENV{'form.action'} eq 'modifystudent') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/dropadd?action=modifystudent', + text=>"Modify Student Data"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'Modify Student Data','Course_Modify_Student_Data')); + 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 { - # 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; + # 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."); + $r->print(&Apache::lonhtmlcommon::breadcrumbs + (undef,'Enrollment Manager')); + &print_main_menu($r); } + # + # Finish up + $r->print(''); return OK; } +################################################################### +################################################################### + 1; __END__ +