--- loncom/interface/Attic/londropadd.pm 2002/10/16 18:45:10 1.59 +++ loncom/interface/Attic/londropadd.pm 2003/08/14 16:08:46 1.82 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# $Id: londropadd.pm,v 1.59 2002/10/16 18:45:10 matthew Exp $ +# $Id: londropadd.pm,v 1.82 2003/08/14 16:08:46 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -32,7 +32,7 @@ # (TeX Content Handler # ############################################################### -############################################################### +############################################################## package Apache::londropadd; @@ -41,6 +41,7 @@ use Apache::lonnet(); use Apache::loncommon(); use Apache::lonhtmlcommon(); use Apache::Constants qw(:common :http REDIRECT); +use Spreadsheet::WriteExcel; ############################################################### ############################################################### @@ -78,13 +79,16 @@ sub modifystudent { # We are in this course my $section=$1; $section='' if ($course eq $courseid.'_st'); - if ( ((!$section) && (!$csec)) || ($section ne $csec) ) { + if ($section eq $csec) { + $result .= 'ok:'; + } elsif ( ((!$section) && (!$csec)) || ($section ne $csec) ) { my (undef,$end,$start)=split(/\_/,$roles{$course}); my $now=time; # if this is an active role if (!($start && ($now<$start)) || !($end && ($now>$end))) { my $reply=&Apache::lonnet::modifystudent - ($udom,$unam,'','','','','','','', + # dom name id mode pass f m l g + ($udom,$unam,'', '', '',undef,undef,undef,undef, $section,time,undef,undef,$desiredhost); $result .= $reply.':'; } @@ -92,7 +96,7 @@ 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; } @@ -150,7 +154,7 @@ sub print_main_menu {

- View Classlist + View Class List

@@ -181,6 +185,7 @@ sub print_upload_manager_header { $javascript=&upload_manager_javascript_forward_associate(); } my $javascript_validations=&javascript_validations($krbdefdom); + my $checked=(($ENV{'form.noFirstLine'})?' checked="1"':''); $r->print(<Uploading Class List

@@ -194,6 +199,7 @@ to this page if the data selected is ins +Ignore First Line @@ -212,14 +218,16 @@ sub javascript_validations { my %param = ( formname => 'studentform', kerb_def_dom => $krbdefdom ); my $authheader = &Apache::loncommon::authform_header(%param); + my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition(); 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 + ); my $krbform = &Apache::loncommon::authform_kerberos(%param); my $intform = &Apache::loncommon::authform_internal(%param); my $locform = &Apache::loncommon::authform_local(%param); my $domform = &domain_form($defdom); + my $date_table = &date_setting_table(); $r->print(< @@ -482,18 +489,9 @@ $locform

LON-CAPA Domain for Students

LON-CAPA domain: $domform

Starting and Ending Dates

- - - - - -Set Starting Date

- -Set Ending Date

+

+$date_table +

Full Update

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

@@ -509,7 +507,7 @@ ENDPICK # ======================================================= Menu Phase Two Upload sub print_upload_manager_form { my $r=shift; - + my $firstLine; my $datatoken; if (!$ENV{'form.datatoken'}) { $datatoken=&Apache::loncommon::upfile_store($r); @@ -518,14 +516,14 @@ sub print_upload_manager_form { &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'); + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom); my $i; my $keyfields; @@ -538,7 +536,8 @@ sub print_upload_manager_form { ['gen','Generation'], ['id','ID/Student Number'], ['sec','Group/Section'], - ['ipwd','Initial Password']); + ['ipwd','Initial Password'], + ['email','EMail Address']); if ($ENV{'form.upfile_associate'} eq 'reverse') { &Apache::loncommon::csv_print_samples($r,\@records); $i=&Apache::loncommon::csv_print_select_table($r,\@records,\@d); @@ -557,6 +556,18 @@ sub print_upload_manager_form { # ======================================================= Enroll single student 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)); + } + $r->print('

Enrolling Student

'); $r->print('

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

'); @@ -603,8 +614,8 @@ sub enroll_single_student { $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'}, + $ENV{'form.csec'},$enddate, + $startdate,$ENV{'form.forceid'}, $desiredhost); if ($login_result =~ /^ok/) { $r->print($login_result); @@ -614,37 +625,224 @@ sub enroll_single_student { $r->print("unable to enroll: ".$login_result); } } else { - $r->print('

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

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

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

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

Enroll One Student

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

Password

+Please select an authentication mechanism + +

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

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

Personal Data

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

Login Data

-

Username:

-

Domain: $domform

-

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

-$krbform -

-$intform -

-$locform -

+$user_data_html

Course Data

Group/Section:

- - - - - - -

-Set Starting Date -

-Set Ending Date +$date_table

ID/Student Number

@@ -764,15 +932,18 @@ sub print_html_classlist {

\n"); @@ -793,14 +964,15 @@ END } # ============================================== view classlist -sub print_csv_classlist { +sub print_formatted_classlist { my $r=shift; + my $mode = shift; my $cid=$ENV{'request.course.id'}; my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); if (! defined($classlist)) { $r->print("There are no students currently enrolled.\n"); } else { - &show_class_list($r,'csv','nolink','csv', + &show_class_list($r,$mode,'nolink','csv', $ENV{'form.Status'},$classlist,$keylist); } } @@ -809,8 +981,10 @@ sub print_csv_classlist { sub show_class_list { my ($r,$mode,$linkto,$action,$statusmode,$classlist,$keylist)=@_; my $cid=$ENV{'request.course.id'}; -# &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, -# ['sortby']); + # + # 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'; @@ -853,6 +1027,22 @@ END $r->print('"'.join('","',("username","domain","ID","student name", "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 @@ -917,9 +1107,18 @@ END $" = '","'; $r->print("\"@line\"\n"); $" = $tmp; + } elsif ($mode eq 'excel') { + $excel_sheet->write($row++,0,[$username,$domain,$id, + $name,$section,$status]); } } - $r->print('
') if ($mode eq 'view'); + if ($mode eq 'view') { + $r->print('
'); + } elsif ($mode eq 'excel') { + $excel_workbook->close(); + $r->print('

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

'."\n"); + } } @@ -951,12 +1150,7 @@ sub print_modify_student_form { # determine the students starting and ending times and section my ($starttime,$endtime,$section) = &get_enrollment_data($sname,$sdom); # Deal with date forms - my $startdateform = &Apache::lonhtmlcommon::date_setter('studentform', - 'startdate', - $starttime); - my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform', - 'enddate', - $endtime); + my $date_table = &date_setting_table($starttime,$endtime); # if (! exists($ENV{'form.Status'}) || $ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { @@ -996,12 +1190,8 @@ Disable ID/Student Number Safeguard and (only do if you know what you are doing)

Section: -

- - - -
Starting Date:$startdateform
Ending Date:$enddateform

+

$date_table

END @@ -1013,6 +1203,15 @@ END # 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'}; @@ -1045,15 +1244,12 @@ sub modify_single_student { my $section = $ENV{'form.section'}; my $courseid = $ENV{'request.course.id'}; my $sid = $ENV{'form.id'}; - my $starttime = &Apache::lonhtmlcommon::get_date_from_form('startdate', - time); - my $endtime = &Apache::lonhtmlcommon::get_date_from_form('enddate', - time); my $displayable_starttime = localtime($starttime); my $displayable_endtime = localtime($endtime); # # check for forceid override - if (($sid ne $old{'id'}) && (! exists($ENV{'form.forceid'}))) { + if ((defined($old{'id'})) && ($old{'id'} ne '') && + ($sid ne $old{'id'}) && (! exists($ENV{'form.forceid'}))) { $r->print("You changed the students id ". " but did not disable the ID change safeguard.". " The students id will not be changed."); @@ -1098,13 +1294,21 @@ sub modify_single_student {

Role Information

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

END # - # Send request(s) to modify data + # Send request(s) to modify data (final undef is for 'desiredhost', + # which is a moot point because the student already has an account. + my $modify_section_results = &modifystudent($sdom,$slogin, + $ENV{'request.course.id'}, + $section,undef); + if ($modify_section_results !~ /^ok/) { + $r->print("An error occured during the attempt to change the ". + "section for this student.
"); + } my $roleresults = &Apache::lonnet::modifystudent ($sdom,$slogin,$sid,undef,undef,$firstname,$middlename,$lastname, $generation,$section,$endtime,$starttime,$ENV{'form.forceid'}); @@ -1150,7 +1354,6 @@ sub get_enrollment_data { my $section = ''; my $count = scalar(keys(%roles)); while (my ($course,$role) = each(%roles)) { - &Apache::lonnet::logthis('course = '.$course.' role = '.$role); if ($course=~ /^\/$courseid\/*\s*(\w+)*_st$/ ) { # # Get active role @@ -1328,6 +1531,7 @@ $upfile_select + Ignore First Line

$create_classlist_help
$create_csv_help @@ -1341,6 +1545,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=(); @@ -1354,10 +1559,10 @@ sub upfile_drop_add { } } # - my $startdate = $ENV{'form.startdate'}; - my $enddate = $ENV{'form.enddate'}; - if ($startdate=~/\D/) { $startdate=''; } - if ($enddate=~/\D/) { $enddate=''; } + 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'}; @@ -1389,11 +1594,19 @@ sub upfile_drop_add { $genpwd=$ENV{'form.locarg'}; } } + if ($amode =~ /^krb/) { + if (! defined($genpwd) || $genpwd eq '') { + $r->print(''. + 'Unable to enroll students:'.' '. + '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('

Enrolling Students

'."\n".'

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

Unacceptable username: '. + $r->print('
Unacceptable username: '. $entries{$fields{'username'}}.' for user '. - $fname.' '.$mname.' '.$lname.' '.$gen.'

'); + $fname.' '.$mname.' '.$lname.' '.$gen.''); } else { # determine section number my $sec=''; @@ -1434,6 +1647,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'})) { @@ -1442,6 +1657,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) { @@ -1464,11 +1687,12 @@ sub upfile_drop_add { 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('
'.$username.':'. + ' Unable to enroll: '.$reply); } else { $count++; $flushc++; $student{$username}=1; @@ -1479,12 +1703,13 @@ sub upfile_drop_add { } } } else { - $r->print("

No password for $username

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

Processed Students: '.$count.'

'); + $r->print('

Processed Students: '.$count.'

'); $r->print("

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

"); ##################################### @@ -1560,7 +1785,8 @@ The response to the request is governed upload enrolling enroll students based on upload drop undefined print the classlist ready to drop drop done drop the selected students - enrollstudent undefined print single student enroll menu + 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 @@ -1628,17 +1854,21 @@ sub handler { } } 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 { - &print_enroll_single_student_form($r); + &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_csv_classlist($r); + &print_formatted_classlist($r,'csv'); + } elsif ($ENV{'form.state'} eq 'excel') { + &print_formatted_classlist($r,'excel'); } else { &print_html_classlist($r); }

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