--- loncom/interface/Attic/londropadd.pm 2002/04/26 19:10:54 1.32 +++ loncom/interface/Attic/londropadd.pm 2002/09/18 14:17:47 1.51 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# $Id: londropadd.pm,v 1.32 2002/04/26 19:10:54 matthew Exp $ +# $Id: londropadd.pm,v 1.51 2002/09/18 14:17:47 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -31,51 +31,37 @@ # # (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); -# ================================================================ Print header - +############################################################### +############################################################### sub header { + my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager'); return(< -LON-CAPA Student Drop/Add +LON-CAPA Enrollment Manager - - -

Drop/Add Students

-
-

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

+$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)=@_; + my ($udom,$unam,$courseid,$csec,$desiredhost)=@_; # if $csec is undefined, drop the student from all the courses matching # this one. If $csec is defined, drop them from all other sections of # this course and add them to section $csec @@ -84,27 +70,38 @@ sub modifystudent { my %roles = &Apache::lonnet::dump('roles',$udom,$unam); my ($tmp) = keys(%roles); # Bail out if we were unable to get the students roles - return if ($tmp =~ /^(con_lost|error|no_such_host)/i); + return "$1" if ($tmp =~ /^(con_lost|error|no_such_host)/i); # Go through the roles looking for enrollment in this course + my $result = ''; foreach my $course (keys(%roles)) { - my $value = $roles{$course}; - if ($course=~/^$courseid(?:\/)*(\w+)*\_st$/) { + if ($course=~/^$courseid(?:\/)*(?:\s+)*(\w+)*\_st$/) { # We are in this course my $section=$1; $section='' if ($course eq $courseid.'_st'); - if (((!$section) && (!$csec)) || ($section ne $csec)) { + if ( ((!$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,'','','','','','','',$section,time); + ($udom,$unam,'','','','','','','', + $section,time,undef,undef,$desiredhost); + $result .= $reply.':'; } } } } + if ($result eq '') { + $result eq '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 @@ -121,7 +118,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}"; @@ -133,42 +130,68 @@ 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

-

-

-

Drop students

-

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

+ + Enroll a single student + +

+ + Modify student data + +

+ + View Classlist + +

+ + Drop Students + +

+END } -sub phase_two_header { +############################################################### +############################################################### +sub print_upload_manager_header { my ($r,$datatoken,$distotal,$krbdefdom)=@_; my $javascript; + if (! exists($ENV{'form.upfile_associate'})) { + $ENV{'form.upfile_associate'} = 'forward'; + } + if ($ENV{'form.associate'} eq 'Reverse Association') { + if ( $ENV{'form.upfile_associate'} ne 'reverse' ) { + $ENV{'form.upfile_associate'} = 'reverse'; + } else { + $ENV{'form.upfile_associate'} = 'forward'; + } + } if ($ENV{'form.upfile_associate'} eq 'reverse') { - $javascript=&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.
- - + + + + @@ -182,6 +205,8 @@ $javascript_validations ENDPICK } +############################################################### +############################################################### sub javascript_validations { my ($krbdefdom)=@_; my %param = ( formname => 'studentform', @@ -242,10 +267,12 @@ function verify_message (vf,founduname,f message+='Continue enrollment?'; if (confirm(message)) { pclose(); + vf.state.value='enrolling'; vf.submit(); } } else { pclose(); + vf.state.value='enrolling'; vf.submit(); } } @@ -283,7 +310,9 @@ ENDPICK } -sub phase_two_javascript_forward_associate { +############################################################### +############################################################### +sub upload_manager_javascript_forward_associate { return(<=3) && @@ -324,6 +368,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) { @@ -331,6 +377,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); @@ -352,7 +400,9 @@ function clearpwd(vf) { ENDPICK } -sub phase_two_javascript_reverse_associate { +############################################################### +############################################################### +sub upload_manager_javascript_reverse_associate { return(< 'document.studentform'); my $krbform = &Apache::loncommon::authform_kerberos(%param); @@ -449,13 +501,13 @@ LON-CAPA domain: $domform

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

-
-Note: for large courses, this operation might be time consuming. +
+Note: for large courses, this operation may be time consuming. ENDPICK } # ======================================================= Menu Phase Two Upload -sub menu_phase_two_upload { +sub print_upload_manager_form { my $r=shift; my $datatoken; @@ -474,14 +526,18 @@ sub menu_phase_two_upload { my $today=time; my $halfyear=$today+15552000; my $defdom=$r->dir_config('lonDefDomain'); - &phase_two_header($r,$datatoken,$distotal,$krbdefdom); + &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'], + 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']); if ($ENV{'form.upfile_associate'} eq 'reverse') { &Apache::loncommon::csv_print_samples($r,\@records); @@ -495,14 +551,15 @@ sub menu_phase_two_upload { $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($ENV{'form.cuname'}." in domain ".$ENV{'form.lcdomain'}); + $r->print('

Enrolling '.$ENV{'form.cuname'}." in domain ". + $ENV{'form.lcdomain'}.'

'); if (($ENV{'form.cuname'})&&($ENV{'form.cuname'}!~/\W/)&& ($ENV{'form.lcdomain'})&&($ENV{'form.lcdomain'}!~/\W/)) { # Deal with home server selection @@ -511,19 +568,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'); return; } } - $r->print(" with server $desiredhost :"); + $r->print(" with server $desiredhost :") if (defined($desiredhost)); # End of home server selection logic my $amode=''; my $genpwd=''; if ($ENV{'form.login'} eq 'krb') { - $amode='krb4'; + $amode='krb'; + $amode.=$ENV{'form.krbver'}; $genpwd=$ENV{'form.krbarg'}; } elsif ($ENV{'form.login'} eq 'int') { $amode='internal'; @@ -533,7 +591,12 @@ sub enroll_single_student { $genpwd=$ENV{'form.locarg'}; if (!$genpwd) { $genpwd=" "; } } - if (($amode) && ($genpwd)) { + my $home = &Apache::lonnet::homeserver($ENV{'form.cuname'}, + $ENV{'form.lcdomain'}); + if ((($amode) && ($genpwd)) || ($home ne 'no_host')) { + &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, @@ -542,10 +605,10 @@ sub enroll_single_student { $ENV{'form.csec'},$ENV{'form.enddate'}, $ENV{'form.startdate'},$ENV{'form.forceid'}, $desiredhost)); - &modifystudent($ENV{'form.lcdomain'},$ENV{'form.cuname'}, - $ENV{'request.course.id'},$ENV{'form.csec'}); } else { - $r->print('Invalid login mode or password'); + $r->print('

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

'); } } else { $r->print('Invalid username or domain'); @@ -553,8 +616,9 @@ sub enroll_single_student { } # ======================================================= Menu Phase Two Enroll -sub 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; @@ -569,7 +633,10 @@ sub menu_phase_two_enroll { # Set up domain selection form my $domform = &domain_form($defdom); # Print it all out - $r->print(<print(< + +

Personal Data

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

ID/Student Number:

- -

Group/Section:

+ + + + + +
First Name:
Middle Name:
Last Name:
Generation:

Login Data

Username:

@@ -627,12 +692,17 @@ $intform

$locform

-

Starting and Ending Dates

- - - - - + +

Course Data

+ +

Group/Section: +

+ + + + + +

Set Ending Date -

+

ID/Student Number

+

+ID/Student Number: +

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

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

+

-ENDSENROLL +END + return; } # =================================================== 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 { - return ($tmp,undef); - } + my $r = shift; + # Call DownloadClasslist + my $cid = $ENV{'request.course.id'}; + my $c = $r->connection; + my $classlisthash = &Apache::loncoursedata::DownloadClasslist + ($cid,'Not downloaded',$c); + # Call ProcessClasslist + my %cache; + my @students = &Apache::loncoursedata::ProcessClasslist(\%cache, + $classlisthash, + $cid,$c); + return (\@students,\%cache); } # ========================================================= Menu Phase Two Drop -sub menu_phase_two_drop { +sub print_drop_menu { my $r=shift; + $r->print("

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)) { - $r->print('
ERROR:$error
'); + my ($student_array,$student_data)=&get_current_classlist($r); + if (! scalar(@$student_array)) { + $r->print("There are no students currently enrolled.\n"); + return; } - if (!defined(%currentlist)) { + # Print out the available choices + &show_drop_list($student_array,$student_data,$r); + return; +} + +# ============================================== view classlist +sub print_html_classlist { + my $r=shift; + $r->print(< +Current Classlist      +CSV format +

+END + my $cid=$ENV{'request.course.id'}; + my ($student_array,$student_data)=&get_current_classlist($r); + if (! scalar(@$student_array)) { $r->print("There are no students currently enrolled.\n"); } else { # Print out the available choices - &show_drop_list($r,%currentlist); + if ($ENV{'form.action'} eq 'modifystudent') { + &show_class_list($r,'view','modify',$student_array,$student_data); + } else { + &show_class_list($r,'view','aboutme',$student_array,$student_data); + } + } +} + +# ============================================== view classlist +sub print_csv_classlist { + my $r=shift; + my $cid=$ENV{'request.course.id'}; + my ($student_array,$student_data)=&get_current_classlist($r); + if (! scalar(@$student_array)) { + $r->print("There are no students currently enrolled.\n"); + } else { + &show_class_list($r,'csv','nolink',$student_array,$student_data); + } +} + +# =================================================== Show student list to drop +sub show_class_list { + my ($r,$mode,$linkto,$students,$student_data)=@_; + my $cid=$ENV{'request.course.id'}; + # Print out header + if ($mode eq 'view') { + if ($linkto eq 'aboutme') { + $r->print('Select a user name to view the users page.'); + } elsif ($linkto eq 'modify') { + $r->print('Select a user name to modify the students information'); + } + $r->print(< + + + +END + } elsif ($mode eq 'csv') { + $r->print('"'.join('","',("username","domain","ID","student name", + "section")).'"'."\n"); + } + foreach my $student (@$students) { + my $username = $student_data->{$student.':username'}; + my $domain = $student_data->{$student.':domain'}; + my $section = $student_data->{$student.':section'}; + my $name = $student_data->{$student.':fullname'}; + my $status = $student_data->{$student.':Status'}; + my $id = $student_data->{$student.':id'}; + next if ($status ne 'Active'); + if ($mode eq 'view') { + $r->print("\n + + + + + +END + } elsif ($mode eq 'csv') { + # no need to bother with $linkto + my @line = (); + foreach ($username,$domain,$id,$name,$section) { + push @line,&Apache::loncommon::csv_translate($_); + } + my $tmp = $"; + $" = '","'; + $r->print("\"@line\"\n"); + $" = $tmp; + } + } + $r->print('
usernamedomainIDstudent namesection
\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

') if ($mode eq 'view'); +} + + +# +# 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'}; + # determine the students name information + 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('Error'. + '

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

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

'); + return; + } + # determine the students starting and ending times and section + my ($starttime,$endtime,$section) = &get_enrollment_data($sname,$sdom); + # Deal with date forms + my $startdateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'startdate', + $starttime); + my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform', + 'enddate', + $endtime); + # Make sure student is enrolled in course + $r->print(< + + + +

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

+

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

+Section: +

+ + + +
Starting Date:$startdateform
Ending Date:$enddateform
+

+ + +END + return; +} + +# +# modify a single students section +# +sub modify_single_student { + my $r = shift; + # make sure user can modify student 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 $sname = $ENV{'form.slogin'}; + my $sdom = $ENV{'form.sdomain'}; + 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); + # talk to the user about what we are going to do + $r->print(< +

Student Information

+ + + + + +
First name $firstname
Middle name $middlename
Last name $lastname
Generation $generation
+

Role Information

+ + + + +
Section $section
Start Time $displayable_starttime
End Time $displayable_endtime
+END + # send request(s) to modify data + my $roleresults = 'refused'; + #my $roleresults = &Apache::lonnet::assignrole($sdom,$sname, + # $courseid.'/'.$section, + # 'st', + # $endtime,$starttime); + if ($roleresults =~/refused/) { + $r->print("Your request to change the role information for this ". + "student was refused."); + } elsif ($roleresults !~ /ok/) { + $r->print("An error occurred during the attempt to change the role". + " information for this student. The error reported was ". + $roleresults); + } else { # everything is okay! + $r->print("Student role updated successfully."); + } + # + $r->print(< +END + return; +} + +sub get_enrollment_data { + my ($sname,$sdomain) = @_; + my $courseid = $ENV{'request.course.id'}; + $courseid =~ s:_:/:g; + my %roles = &Apache::lonnet::dump('roles',$sdomain,$sname); + my ($tmp) = keys(%roles); + # Bail out if we were unable to get the students roles + return "666" if ($tmp =~ /^(con_lost|error|no_such_host)/i); + # Go through the roles looking for enrollment in this course + my ($end,$start) = (undef,undef); + my $section = ''; + my $count = scalar(keys(%roles)); + while (my ($course,$role) = each(%roles)) { + &Apache::lonnet::logthis('course = '.$course.' role = '.$role); + if ($course=~ /^\/$courseid\/*\s*(\w+)*_st$/ ) { + # + # Get active role + $section=$1; + (undef,$end,$start)=split(/\_/,$role); + my $now=time; + my $notactive=0; + if ($start) { + if ($now<$start) { $notactive=1; } + } + if ($end) { + if ($now>$end) { $notactive=1; } + } + unless ($notactive) { return ($start,$end,$section); } + } } + return ($start,$end,$section); } # =================================================== Show student list to drop sub show_drop_list { - my ($r,%currentlist)=@_; + my ($students,$student_data,$r)=@_; my $cid=$ENV{'request.course.id'}; $r->print(<<'END'); + +