--- loncom/interface/Attic/londropadd.pm 2002/04/26 19:10:54 1.32 +++ loncom/interface/Attic/londropadd.pm 2002/09/24 18:24:43 1.52 @@ -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.52 2002/09/24 18:24:43 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(<<ENDHEAD); <html> <head> -<title>LON-CAPA Student Drop/Add</title> +<title>LON-CAPA Enrollment Manager</title> </head> -<body bgcolor="#FFFFFF"> -<img align=right src=/adm/lonIcons/lonlogos.gif> -<h1>Drop/Add Students</h1> -<form method="post" enctype="multipart/form-data" -action="/adm/dropadd" name="studentform"> -<h2>Course: $ENV{'course.'.$ENV{'request.course.id'}.'.description'}</h2> +$bodytag +<form method="post" enctype="multipart/form-data" + action="/adm/dropadd" name="studentform"> 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(<<ENDUPFORM); -<input type=hidden name=phase value=two> -<hr> -<h3>Upload a courselist</h3> -$upfile_select -<p><input type=submit name=fileupload value="Upload Courselist"> -<hr> -<h3>Enroll a single student</h3> -<p><input type=submit name=enroll value="Enroll Student"> -<hr> -<h3>Drop students</h3> -<p><input type=submit name=drop value="Selection List"> -ENDUPFORM + $r->print(<<END); +<p> +<font size="+1"> + <a href="/adm/dropadd?action=upload">Upload a course list</a> +</font> +</p><p> +<font size="+1"> + <a href="/adm/dropadd?action=enrollstudent">Enroll a single student</a> +</font> +</p><p> +<font size="+1"> + <a href="/adm/dropadd?action=modifystudent">Modify student data</a> +</font> +</p><p> +<font size="+1"> + <a href="/adm/dropadd?action=classlist">View Classlist</a> +</font> +</p><p> +<font size="+1"> + <a href="/adm/dropadd?action=drop">Drop Students</a> +</font> +</p> +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(<<ENDPICK); +<h3>Uploading Class List</h3> <hr> <h3>Identify fields</h3> Total number of records found in file: $distotal <hr /> 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.<hr /> -<input type="submit" name="associate" value="Reverse Association" /> -<input type="hidden" name="phase" value="three" /> +<input type="button" value="Reverse Association" onClick="javascript:this.form.associate.value='Reverse Association';submit(this.form);" /> +<input type="hidden" name="action" value="upload" /> +<input type="hidden" name="state" value="got_file" /> +<input type="hidden" name="associate" value="" /> <input type="hidden" name="datatoken" value="$datatoken" /> <input type="hidden" name="fileupload" value="$ENV{'form.fileupload'}" /> <input type="hidden" name="upfiletype" value="$ENV{'form.upfiletype'}" /> @@ -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(<<ENDPICK); function verify(vf) { var founduname=0; @@ -303,19 +332,34 @@ function verify(vf) { verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec); } +// +// vf = this.form +// tf = column number +// +// values of nw +// +// 0 = none +// 1 = username +// 2 = names (lastname, firstnames) +// 3 = fname (firstname) +// 4 = mname (middlename) +// 5 = lname (lastname) +// 6 = gen (generation) +// 7 = id +// 8 = section +// 9 = ipwd (password) +// function flip(vf,tf) { var nw=eval('vf.f'+tf+'.selectedIndex'); var i; + // make sure no other columns are labeled the same as this one for (i=0;i<=vf.nfields.value;i++) { if ((i!=tf) && (eval('vf.f'+i+'.selectedIndex')==nw)) { eval('vf.f'+i+'.selectedIndex=0;') } } - if (tf==1 && nw!=0) { - for (i=2;i<=5;i++) { - eval('vf.f'+i+'.selectedIndex=0;') - } - } + // If we set this to 'lastname, firstnames', clear out all the ones + // set to 'fname','mname','lname','gen' (3,4,5,6) currently. if (nw==2) { for (i=0;i<=vf.nfields.value;i++) { if ((eval('vf.f'+i+'.selectedIndex')>=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(<<ENDPICK); function verify(vf) { var founduname=0; @@ -405,7 +455,9 @@ function clearpwd(vf) { ENDPICK } -sub phase_two_end { +############################################################### +############################################################### +sub print_upload_manager_footer { my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_; my %param = ( formname => 'document.studentform'); my $krbform = &Apache::loncommon::authform_kerberos(%param); @@ -449,13 +501,13 @@ LON-CAPA domain: $domform <p> <input type=checkbox name=forceid value=yes> Disable ID/Student Number Safeguard and Force Change of Conflicting IDs (only do if you know what you are doing)<p> -<input type="button" onClick="verify(this.form)" value="Update Courselist"><br> -Note: for large courses, this operation might be time consuming. +<input type="button" onClick="javascript:verify(this.form)" value="Update Courselist" /><br /> +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('<h3>Enrolling Student</h3>'); - $r->print($ENV{'form.cuname'}." in domain ".$ENV{'form.lcdomain'}); + $r->print('<p>Enrolling '.$ENV{'form.cuname'}." in domain ". + $ENV{'form.lcdomain'}.'</p>'); 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('<font color="#ff0000">Error:</font>'. '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('<p><font color="#ff0000">ERROR</font> '. + 'Invalid login mode or password. '. + 'Unable to enroll '.$ENV{'form.cuname'}.'.</p>'); } } 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("<h3>Enroll One Student</h3>"); 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(<<ENDSENROLL); + $r->print(<<END); +<input type="hidden" name="action" value="enrollstudent"> +<input type="hidden" name="state" value="done"> + <script type="text/javascript" language="Javascript"> function verify(vf) { var founduname=0; @@ -607,14 +674,12 @@ function clearpwd(vf) { </script> <h3>Personal Data</h3> -First Name: <input type="text" name="cfirst" size="15"><br> -Middle Name: <input type="text" name="cmiddle" size="15"><br> -Last Name: <input type="text" name="clast" size="15"><br> -Generation: <input type="text" name="cgen" size="5"> - -<p>ID/Student Number: <input type="text" name="cstid" size="10"></p> - -<p>Group/Section: <input type=text name=csec size=5></p> +<table> +<tr><td>First Name:</td><td> <input type="text" name="cfirst" size="15"></td></tr> +<tr><td>Middle Name:</td><td> <input type="text" name="cmiddle" size="15"></td></tr> +<tr><td>Last Name: </td><td><input type="text" name="clast" size="15"></td></tr> +<tr><td>Generation: </td><td><input type="text" name="cgen" size="5"> </td></tr> +</table> <h3>Login Data</h3> <p>Username: <input type="text" name="cuname" size="15"></p> @@ -627,12 +692,17 @@ $intform </p><p> $locform </p><p> -<h3>Starting and Ending Dates</h3> -<input type="hidden" value='' name="pres_value"> -<input type="hidden" value='' name="pres_type"> -<input type="hidden" value='' name="pres_marker"> -<input type="hidden" value='$today' name=startdate> -<input type="hidden" value='$halfyear' name=enddate> + +<h3>Course Data</h3> + +<p>Group/Section: <input type="text" name="csec" size="5" /> +<p> +<!-- Date setting form elements --> +<input type="hidden" name="pres_value" value='' /> +<input type="hidden" name="pres_type" value='' /> +<input type="hidden" name="pres_marker" value='' /> +<input type="hidden" name="startdate" value='$today' /> +<input type="hidden" name="enddate" value='$halfyear' /> </p><p> <a href="javascript:pjump('date_start','Enrollment Starting Date',document.studentform.startdate.value,'start','studentform.pres','dateset');" @@ -641,72 +711,351 @@ $locform <a href="javascript:pjump('date_end','Enrollment Ending Date',document.studentform.enddate.value,'end','studentform.pres','dateset');" >Set Ending Date</a> -</p><p> +</p> <h3>ID/Student Number</h3> +<p> +ID/Student Number: <input type="text" name="cstid" size="10"> +</p><p> <input type="checkbox" name="forceid" value="yes"> Disable ID/Student Number Safeguard and Force Change of Conflicting IDs -(only do if you know what you are doing)<p> -<input type="button" onClick="verify(this.form)" value="Enroll as student"><br> -<input type="hidden" name="phase" value="five"> +(only do if you know what you are doing) +</p><p> +<input type="button" onClick="verify(this.form)" value="Enroll as student"> </p> -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("<h3>Drop Students</h3>"); 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('<pre>ERROR:$error</pre>'); + 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(<<END); +<p> +<font size="+1">Current Classlist</font> +<font size="+1"><a href="/adm/dropadd?action=classlist&state=csv">CSV format</a></font> +</p> +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','any',$student_array,$student_data); + } else { + &show_class_list($r,'view','aboutme','any',$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','any',$student_array,$student_data); + } +} + +# =================================================== Show student list to drop +sub show_class_list { + my ($r,$mode,$linkto,$statusmode,$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); +<p> +<table border=2> +<tr><th>username</th><th>domain</th><th>ID</th> + <th>student name</th><th>section</th></tr> +END + } elsif ($mode eq 'csv') { + $r->print('"'.join('","',("username","domain","ID","student name", + "section")).'"'."\n"); + } + foreach my $student (@$students) { + my $error; + if (exists($student_data->{$student.':error'})) { + $error = $student_data->{$student.':error'}; + } + if ($error) { + $r->print('<tr><td colspan="6">'. + '<font color="#FF8888">Error</font>'. + 'Error retrieving data for '. + join('@',split(/:/,$student)). + ', '.$error.'</td></tr>'."\n"); + next; + } + 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 (($statusmode ne 'any') && ($status ne $statusmode)); + if ($mode eq 'view') { + $r->print("<tr>\n <td>\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('<a href="/adm/dropadd?action=modifystudent'. + '&state=selected'.'&sname='.$username. + '&sdom='.$domain.'">'.$username."</a>\n"); + } + $r->print(<<"END"); + </td> + <td>$domain</td> + <td>$id</td> + <td>$name</td> + <td>$section</td> +</tr> +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('</table><br>') 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','id'], + $sdom, $sname); + my ($tmp) = keys(%info); + if ($tmp =~ /^(con_lost|error|no_such_host)/i) { + $r->print('<font color="#ff0000" size="+2">Error</font>'. + '<p>'. + 'Unable to retrieve environment data for '.$sname. + 'in domain '.$sdom.'</p><p>'. + 'Please contact your LON-CAPA administrator '. + 'regarding this situation.</p></body></html>'); + 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(<<END); +<p> +<font size="+1"> +Only domain coordinators can change a users password. +</font> +</p> +<input type="hidden" name="slogin" value="$sname" /> +<input type="hidden" name="sdomain" value="$sdom" /> +<input type="hidden" name="action" value="modifystudent" /> +<input type="hidden" name="state" value="done" /> +<h2>Modify Enrollment for $info{'firstname'} $info{'middlename'} +$info{'lastname'} $info{'generation'}, $sname\@$sdom</h2> +<p> +<b>Student Name</b> +<table> +<tr><th>First</th><th>Middle</th><th>Last</th><th>Generation</th></tr> +<tr><td> +<input type="text" name="firstname" value="$info{'firstname'}" /></td><td> +<input type="text" name="middlename" value="$info{'middlename'}" /></td><td> +<input type="text" name="lastname" value="$info{'lastname'}" /></td><td> +<input type="text" name="generation" value="$info{'generation'}" /></td></tr> +</table> +</p><p> +<b>Student ID</b>: <input type="text" name="id" value="$info{'id'}" size="12"/> +</p><p> +<b>Section</b>: <input type="text" name="section" value="$section" size="4"/> +</p><p> +<table> +<tr><td align="right"><b>Starting Date:</b></td><td>$startdateform</td></tr> +<tr><td align="right"><b>Ending Date:</b></td><td>$enddateform</td></tr> +</table> +</p> +<input type="submit" value="Submit Modifications" /> +</body></html> +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 $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); + # talk to the user about what we are going to do + $r->print(<<END); +<h2>Modifying data for user $sname \@ $sdom </h2> +<h3>Student Information</h3> +<table> +<tr><td>First name </td><td> $firstname </td></tr> +<tr><td>Middle name </td><td> $middlename </td></tr> +<tr><td>Last name </td><td> $lastname </td></tr> +<tr><td>Generation </td><td> $generation </td></tr> +</table> +<h3>Role Information</h3> +<table> +<tr><td>Section </td><td> $section </td></tr> +<tr><td>Start Time </td><td> $displayable_starttime </td></tr> +<tr><td>End Time </td><td> $displayable_endtime </td></tr> +</table> +<p> +END + # Send request(s) to modify data + # The '1' in the call to modifystudent is to force the students + # id to be changed. + my $roleresults = &Apache::lonnet::modifystudent + ($sdom,$sname,$sid,undef,undef,$firstname,$middlename,$lastname, + $generation,$section,$endtime,$starttime,1); + 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. <br />". + "The error reported was ". + $roleresults); + } else { # everything is okay! + $r->print("Student information updated successfully. <br />". + "The student must log out and log in again to see ". + "these changes."); + } + $r->print(<<END); +</p><p> +<a href="/adm/dropadd?action=modifystudent">Modify another students data</a> +</body></html> +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'); +<input type="hidden" name="action" value="drop" /> +<input type="hidden" name="state" value="done" /> <script> -function checkAll(field) -{ +function checkAll(field) { for (i = 0; i < field.length; i++) field[i].checked = true ; } -function uncheckAll(field) -{ +function uncheckAll(field) { for (i = 0; i < field.length; i++) field[i].checked = false ; } @@ -715,35 +1064,39 @@ function uncheckAll(field) <input type="hidden" name="phase" value="four"> <table border=2> <tr><th> </th><th>username</th><th>domain</th> -<th>ID</th><th>student name</th><th>generation</th> -<th>section</th></tr> + <th>ID</th><th>student name</th><th>section</th></tr> 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('<tr><td colspan="7"><font color="red">'. - 'Internal error: unable to get environment '. - 'for '.$sname.' in domain '.$sdom.'</font></td></tr>'); - } else { - $r->print(<<"END"); + foreach my $student (@$students) { + my $error; + if (exists($student_data->{$student.':error'})) { + $error = $student_data->{$student.':error'}; + } + if ($error) { + $r->print('<tr><td colspan="6">'. + '<font color="#FF8888">Error</font>'. + 'Error retrieving data for '. + join('@',split(/:/,$student)). + ', '.$error.'</td></tr>'."\n"); + next; + } + 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'); + # + $r->print(<<"END"); <tr> - <td><input type="checkbox" name="droplist" value="$_"></td> - <td>$sname</td> - <td>$sdom</td> - <td>$reply{$sname}</td> - <td>$info{'lastname'}, $info{'firstname'} $info{'middlename'}</td> - <td>$info{'generation'}</td> - <td>$ssec</td> + <td><input type="checkbox" name="droplist" value="$student"></td> + <td>$username</td> + <td>$domain</td> + <td>$id</td> + <td>$name</td> + <td>$section</td> </tr> END - } } $r->print('</table><br>'); $r->print(<<"END"); @@ -752,6 +1105,35 @@ END <input type="button" value="uncheck all" onclick="javascript:uncheckAll(document.studentform.droplist)"> <p><input type=submit value="Drop Students"></p> END + return; +} + +# +# Print out the initial form to get the courselist file +# +sub print_first_courselist_upload_form { + my $r=shift; + my $upfile_select=&Apache::loncommon::upfile_select_html(); + my $create_classlist_help = + &Apache::loncommon::help_open_topic("Course_Create_Class_List", + "How do I create a class list from a spreadsheet"); + my $create_csv_help = + &Apache::loncommon::help_open_topic("Course_Convert_To_CSV", + "How do I create a CSV file from a spreadsheet"); + $r->print(<<ENDUPFORM); +<input type=hidden name=phase value=two> +<h3>Upload a courselist</h3> +$upfile_select +<p> +<input type=submit name="fileupload" value="Upload Courselist"> +<input type="hidden" name="action" value="upload" /> +<input type="hidden" name="state" value="got_file" /> +</p> +$create_classlist_help <br /> +$create_csv_help +</body></html> +ENDUPFORM + return; } # ================================================= Drop/Add from uploaded file @@ -782,7 +1164,7 @@ sub upfile_drop_add { 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('<font color="#ff0000">Error:</font>'. 'Invalid home server specified'); @@ -793,7 +1175,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'; @@ -871,11 +1254,12 @@ sub upfile_drop_add { } } if ($password) { + &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); - &modifystudent($domain,$username,$cid,$sec); if ($reply ne 'ok') { $r->print('<p><b>'. 'Error enrolling '.$username.': '. @@ -902,9 +1286,7 @@ sub upfile_drop_add { if ($ENV{'form.fullup'} eq 'yes') { $r->print('<h3>Dropping Students</h3>'); # Get current classlist - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'}, - $ENV{'course.'.$cid.'.num'}); + my ($error,%currentlist)=&get_current_classlist($r); if (defined($error)) { $r->print('<pre>ERROR:$error</pre>'); } @@ -927,21 +1309,101 @@ sub upfile_drop_add { } # end of unless } +################################################################### +################################################################### + +=pod + +=item &drop_students + +Inputs: \@droplist, a pointer to an array of students to drop. +Students should be in format of studentname:studentdomain + +Returns: $errors, a string describing any errors encountered. +$successes, a string describing the successful dropping of students. + +=cut + +################################################################### +################################################################### +sub drop_students { + my @droplist = @{shift()}; + my $courseid = $ENV{'request.course.id'}; + my $successes = ''; + my $errors = ''; + foreach (@droplist) { + my ($sname,$sdom)=split(/:/,$_); + my $result = &drop_student($sname,$sdom,$courseid); + if ($result !~ /ok/) { + $errors .= "Error dropping $sname\@$sdom: $result\n"; + } else { + $successes .= "Dropped $sname\@$sdom\n"; + } + } + return ($errors,$successes); +} +################################################################### +################################################################### + + # ================================================================== Phase four sub drop_student_list { my $r=shift; my $count=0; - foreach (@{$ENV{'form.droplist'}}) { + my @droplist; + if (ref($ENV{'form.droplist'})) { + @droplist = @{$ENV{'form.droplist'}}; + } else { + @droplist = ($ENV{'form.droplist'}); + } + foreach (@droplist) { my ($uname,$udom)=split(/\:/,$_); - &modifystudent($udom,$uname,$ENV{'request.course.id'}); - $r->print('Dropped '.$uname.' at '.$udom.'<br>'); + my $result = &modifystudent($udom,$uname,$ENV{'request.course.id'}); + if ($result eq 'ok' || $result eq 'ok:') { + $r->print('Dropped '.$uname.' at '.$udom.'<br>'); + } else { + $r->print('Error dropping '.$uname.' at '.$udom.': '.$result. + '<br />'); + } $count++; } $r->print('<p><b>Dropped '.$count.' student(s).</b>'); $r->print('<p>Re-enrollment will re-activate data.'); } -# ================================================================ 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 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) { @@ -949,60 +1411,100 @@ sub handler { $r->send_http_header; return OK; } + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['action','state']); # Needs to be in a course - if (($ENV{'request.course.fn'}) && - (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'}))) { + if (! (($ENV{'request.course.fn'}) && + (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'})))) { + # Not in a course, or not allowed to modify parms + $ENV{'user.error.msg'}= + "/adm/dropadd:cst:0:0:Cannot drop or add students"; + return HTTP_NOT_ACCEPTABLE; + } + # + # Only output the header information if they did not request csv format + # + if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) { + $r->content_type('text/csv'); + } else { # Start page $r->content_type('text/html'); $r->send_http_header; $r->print(&header()); - # 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); - } - } - # Phase three - if ($ENV{'form.phase'} eq 'three') { + } + # + # Main switch on form.action and form.state, as appropriate + if (! exists($ENV{'form.action'})) { + &print_main_menu($r); + } elsif ($ENV{'form.action'} eq 'upload') { + if (! exists($ENV{'form.state'})) { + &print_first_courselist_upload_form($r); + } elsif ($ENV{'form.state'} eq 'got_file') { + &print_upload_manager_form($r); + } elsif ($ENV{'form.state'} eq 'enrolling') { if ($ENV{'form.datatoken'}) { &upfile_drop_add($r); + } else { + # Hmmm, this is an error } + } else { + &print_first_courselist_upload_form($r); } - # Phase four - if ($ENV{'form.phase'} eq 'four') { + } elsif ($ENV{'form.action'} eq 'drop') { + if (! exists($ENV{'form.state'})) { + &print_drop_menu($r); + } elsif ($ENV{'form.state'} eq 'done') { &drop_student_list($r); + } else { + &menu_phase_two_drop($r); } - # Phase five - if ($ENV{'form.phase'} eq 'five') { + } elsif ($ENV{'form.action'} eq 'enrollstudent') { + if (! exists($ENV{'form.state'})) { + &print_enroll_single_student_form($r); + } elsif ($ENV{'form.state'} eq 'enrolling') { &enroll_single_student($r); + } else { + &print_enroll_single_student_form($r); } - # End - $r->print('</form></body></html>'); + } 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); + } else { + &print_html_classlist($r); + } + } elsif ($ENV{'form.action'} eq 'modifystudent') { + if (! exists($ENV{'form.state'})) { + &print_html_classlist($r); + } elsif ($ENV{'form.state'} eq 'selected') { + &print_modify_student_form($r); + } elsif ($ENV{'form.state'} eq 'done') { + &modify_single_student($r); + } else { + &print_html_classlist($r); + } } else { - # 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."); + &print_main_menu($r); + } + # + # Finish up + if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) { + $r->print("\n"); + } else { + $r->print('</form></body></html>'); } return OK; } +################################################################### +################################################################### + 1; __END__ +