--- loncom/interface/Attic/londropadd.pm 2002/10/16 15:02:28 1.58 +++ loncom/interface/Attic/londropadd.pm 2003/07/03 19:26:20 1.72 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# $Id: londropadd.pm,v 1.58 2002/10/16 15:02:28 matthew Exp $ +# $Id: londropadd.pm,v 1.72 2003/07/03 19:26:20 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -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; } @@ -212,6 +216,7 @@ 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 +453,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)

@@ -520,12 +482,11 @@ sub print_upload_manager_form { my @records=&Apache::loncommon::upfile_record_sep(); my $total=$#records; my $distotal=$total+1; - $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; - my $krbdefdom=$1; - $krbdefdom=~tr/a-z/A-Z/; my $today=time; my $halfyear=$today+15552000; my $defdom=$r->dir_config('lonDefDomain'); + my ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom); my $i; my $keyfields; @@ -557,6 +518,16 @@ sub print_upload_manager_form { # ======================================================= Enroll single student sub enroll_single_student { my $r=shift; + # + # We do the dates first because the action of making them the defaul + # in the course is entirely seperate from the action of enrolling the + # student. Also, a failure in setting the dates as default is not fatal + # to the process of enrolling / modifying a student. + my ($startdate,$enddate) = &get_dates_from_form(); + if ($ENV{'form.makedatesdefault'}) { + $r->print(&make_dates_default($startdate,$enddate)); + } + $r->print('

Enrolling Student

'); $r->print('

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

'); @@ -603,8 +574,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); @@ -623,23 +594,106 @@ sub enroll_single_student { } } +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; +} + # ======================================================= Menu Phase Two Enroll 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 ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); + my $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 $domform = &domain_form($defdom); + my $date_table = &date_setting_table(); # Print it all out $r->print(< @@ -705,20 +759,7 @@ $locform

Group/Section:

- - - - - - -

-Set Starting Date -

-Set Ending Date +$date_table

ID/Student Number

@@ -755,8 +796,7 @@ sub print_html_classlist { if (! exists($ENV{'form.sortby'})) { $ENV{'form.sortby'} = 'username'; } - if (! exists($ENV{'form.Status'}) || - $ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { + if ($ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { $ENV{'form.Status'} = 'Active'; } my $status_select = &Apache::lonhtmlcommon::StatusOptions @@ -767,13 +807,19 @@ sub print_html_classlist {

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

+Student Status: END + } + $r->print($status_select."

\n"); my $cid=$ENV{'request.course.id'}; my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); if (! defined($classlist)) { @@ -791,14 +837,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); } } @@ -807,8 +854,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'; @@ -821,7 +870,10 @@ sub show_class_list { $r->print('Select a user name to modify the students information'); } $r->print(< + +

@@ -848,6 +900,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 = 'Classlist 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 @@ -883,9 +951,12 @@ END $username, $domain)); } elsif ($linkto eq 'modify') { - $r->print(''. + $r->print(''. $username."\n"); } $r->print(<<"END"); @@ -909,9 +980,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"); + } } @@ -921,7 +1001,7 @@ END sub print_modify_student_form { my $r = shift(); &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['sdom','sname','sortby']); + ['sdom','sname']); my $sname = $ENV{'form.sname'}; my $sdom = $ENV{'form.sdom'}; my $sortby = $ENV{'form.sortby'}; @@ -943,12 +1023,12 @@ 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)$/) { + $ENV{'form.Status'} = 'crap'; + } # Make sure student is enrolled in course $r->print(< @@ -961,6 +1041,8 @@ Only domain coordinators can change a us + +

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

@@ -981,12 +1063,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 @@ -998,8 +1076,16 @@ END # sub modify_single_student { my $r = shift; - # Get the 'sortby' variable so the user does not need to re-sort + # + # 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'}; @@ -1010,6 +1096,8 @@ sub modify_single_student { ['firstname','middlename', 'lastname','generation','id'], $sdom, $slogin); + $old{'section'} = &Apache::lonnet::getsection($sdom,$slogin, + $ENV{'request.course.id'}); my ($tmp) = keys(%old); if ($tmp =~ /^(con_lost|error|no_such_host)/i) { $r->print("There was an error determining the environment values ". @@ -1026,15 +1114,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."); @@ -1071,18 +1156,29 @@ sub modify_single_student { ID $old{'id'} $sid + + Section + $old{'section'} + $section

Role Information

- - - + +
Section $section
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'}); @@ -1106,7 +1202,10 @@ END } $r->print(<

-Modify another students data + + + +Modify another students data END return; @@ -1125,7 +1224,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 @@ -1175,8 +1273,10 @@ which describes the order elements are s sub show_drop_list { my ($r,$classlist,$keylist,$nosort)=@_; my $cid=$ENV{'request.course.id'}; - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['sortby']); + 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'; @@ -1327,10 +1427,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'}; @@ -1366,7 +1466,7 @@ sub upfile_drop_add { ####################################### ## Enroll Students ## ####################################### - $r->print('

Enrolling Students

'); + $r->print('

Enrolling Students

'."\n".'

'); my $count=0; my $flushc=0; my %student=(); @@ -1395,9 +1495,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=''; @@ -1439,9 +1539,9 @@ sub upfile_drop_add { $fname,$mname,$lname,$gen,$sec,$enddate, $startdate,$ENV{'form.forceid'},$desiredhost); 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; @@ -1452,12 +1552,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.

"); ##################################### @@ -1502,14 +1603,14 @@ sub drop_student_list { my $result = &modifystudent($udom,$uname,$ENV{'request.course.id'}); if ($result eq 'ok' || $result eq 'ok:') { $r->print('Dropped '.$uname.' @ '.$udom.'
'); + $count++; } else { $r->print('Error dropping '.$uname.' @ '.$udom.': '.$result. '
'); } - $count++; } $r->print('

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

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

Re-enrollment will re-activate data.') if ($count); } ################################################################### @@ -1611,7 +1712,9 @@ sub handler { 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); }