--- loncom/interface/Attic/londropadd.pm 2000/12/27 17:58:45 1.3 +++ loncom/interface/Attic/londropadd.pm 2002/10/16 13:00:57 1.57 @@ -1,188 +1,391 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# (Handler to set parameters for assessments +# $Id: londropadd.pm,v 1.57 2002/10/16 13:00:57 matthew Exp $ # -# (Handler to resolve ambiguous file locations +# Copyright Michigan State University Board of Trustees # -# (TeX Content Handler +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. # -# 05/29/00,05/30,10/11 Gerd Kortemeyer) +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +# (Handler to set parameters for assessments # -# 10/11,10/12,10/16 Gerd Kortemeyer) +# (Handler to resolve ambiguous file locations # -# 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28, -# 12/08,12/12 Gerd Kortemeyer) +# (TeX Content Handler # -# 12/26, 12/27 Gerd Kortemeyer +############################################################### +############################################################### package Apache::londropadd; use strict; -use Apache::lonnet; +use Apache::lonnet(); +use Apache::loncommon(); +use Apache::lonhtmlcommon(); use Apache::Constants qw(:common :http REDIRECT); - -# ================================================================ Main Handler - -sub handler { - my $r=shift; - - if ($r->header_only) { - $r->content_type('text/html'); - $r->send_http_header; - return OK; - } - -# ----------------------------------------------------- Needs to be in a course - - if (($ENV{'request.course.fn'}) && - (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'}))) { - -# ------------------------------------------------------------------ Start page - $r->content_type('text/html'); - $r->send_http_header; - $r->print(< -LON-CAPA Student Drop/Add +LON-CAPA Enrollment Manager - - -

Drop/Add Students

-
-

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

+$bodytag + ENDHEAD -# --------------------------------------------------- Phase one, initial screen - unless ($ENV{'form.phase'}) { - $r->print(< -
-

Upload a courselist

- -
Type: -

-

-

Enroll a single student

-

-

-

Drop a student

-

-ENDUPFORM - } -# ------------------------------------------------------------------- Phase two - if ($ENV{'form.phase'} eq 'two') { - if ($ENV{'form.fileupload'}) { - my $datatoken=Apache::lonnet::reply( - 'tmpput:'.Apache::lonnet::escape($ENV{'form.upfile'}), - $r->dir_config('lonHostID')); - my $separator=''; - my $remove=''; - if ($ENV{'form.upfiletype'} eq 'csv') { - $separator='\"\,\s*\"'; - $remove='"'; - } elsif ($ENV{'form.upfiletype'} eq 'space') { - $separator='\s+'; - } elsif ($ENV{'form.upfiletype'} eq 'tab') { - $separator='\t+'; - } elsif ($ENV{'form.upfiletype'} eq 'xml') { - } - my @lines=split(/\n/,$ENV{'form.upfile'}); - my $total=$#lines+1; - $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; - my $krbdefdom=$1; - $krbdefdom=~tr/a-z/A-Z/; - $r->print(< - - +} + +############################################################### +############################################################### +# Drop student from all sections of a course, except optional $csec +sub modifystudent { + my ($udom,$unam,$courseid,$csec,$desiredhost)=@_; + # if $csec is undefined, drop the student from all the courses matching + # this one. If $csec is defined, drop them from all other sections of + # this course and add them to section $csec + $courseid=~s/\_/\//g; + $courseid=~s/^(\w)/\/$1/; + my %roles = &Apache::lonnet::dump('roles',$udom,$unam); + my ($tmp) = keys(%roles); + # Bail out if we were unable to get the students roles + 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)) { + 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) ) { + 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,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 +sub domain_form { + my ($defdom) = @_; + # Set up domain and server selection forms + # + # Get the domains + my @domains = &Apache::loncommon::get_domains(); + # build up the menu information to be passed to + # &Apache::loncommon::linked_select_forms + my %select_menus; + foreach my $dom (@domains) { + # set up the text for this domain + $select_menus{$dom}->{'text'}= $dom; + # we want a choice of 'default' as the default in the second menu + $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_library_servers($dom); + foreach my $server (keys(%servers)) { + $select_menus{$dom}->{'select2'}->{$server} + = "$server $servers{$server}"; + } + } + my $result = &Apache::loncommon::linked_select_forms + ('studentform',' with home server ',$defdom, + 'lcdomain','lcserver',\%select_menus); + return $result; +} + +############################################################### +############################################################### +# Menu Phase One +sub print_main_menu { + my $r=shift; + $r->print(< + + Upload a course list + +

+ + Enroll a single student + +

+ + Modify student data + +

+ + View Classlist + +

+ + Drop Students + +

+END +} + +############################################################### +############################################################### +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=&upload_manager_javascript_reverse_associate(); + } else { + $javascript=&upload_manager_javascript_forward_associate(); + } + my $javascript_validations=&javascript_validations($krbdefdom); + $r->print(<Uploading Class List

Identify fields

-Total number of students: $total - +ENDPICK +} + +############################################################### +############################################################### +sub javascript_validations { + my ($krbdefdom)=@_; + my %param = ( formname => 'studentform', + kerb_def_dom => $krbdefdom ); + my $authheader = &Apache::loncommon::authform_header(%param); + return (<=2) && (tw<=6)) { foundname=1; } if (tw==7) { foundid=1; } - if (tw==8) { foundsec=1; } + if (tw==8) { foundsec=1; } if (tw==9) { foundpwd=1; } } - if (founduname==0) { - alert('You need to specify at least the username field'); - return; - } - if (vf.login[0].checked) { - foundatype=1; - if (vf.krbdom.value=='') { - alert('You need to specify the Kerberos domain'); - return; - } - } - if (vf.login[1].checked) { - foundatype=1; - if ((vf.intpwd.value=='') && (foundpwd==0)) { - alert('You need to specify the initial password'); - return; - } - } - if (foundatype==0) { - alert('You need to set the login type'); - return; - } - if (foundname==0) { message='No name fields specified. '; } - if (foundid==0) { message+='No ID or student number field specified. '; } - if (foundsec==0) { message+='No section or group field specified. '; } - message+='Complete enrollment?'; - if (confirm(message)) { - vf.submit(); - } + 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;') - } + 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) && (eval('vf.f'+i+'.selectedIndex')<=6)) { eval('vf.f'+i+'.selectedIndex=0;') } - } + } } + // 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) { eval('vf.f'+i+'.selectedIndex=0;') } - } + } } + // If we set the password, make the password form below correspond to + // the new value. if (nw==9) { - vf.login[1].checked=true; - vf.intpwd.value=''; - vf.krbdom.value=''; + changed_radio('int',document.studentform); + set_auth_radio_buttons('int',document.studentform); + vf.intarg.value=''; + vf.krbarg.value=''; + vf.locarg.value=''; } - } function clearpwd(vf) { @@ -191,143 +394,1247 @@ function clearpwd(vf) { if (eval('vf.f'+i+'.selectedIndex')==9) { eval('vf.f'+i+'.selectedIndex=0;') } - } + } } -function setkrb(vf) { - if (vf.krbdom.value!='') { - clearpwd(vf); - vf.login[0].checked=true; - vf.krbdom.value=vf.krbdom.value.toUpperCase(); - vf.intpwd.value=''; - } +ENDPICK } -function setint(vf) { - if (vf.intpwd.value!='') { - clearpwd(vf); - vf.login[1].checked=true; - vf.krbdom.value=''; +############################################################### +############################################################### +sub upload_manager_javascript_reverse_associate { + return(<=1) && (i<=5)) && tw!=0 ) { foundname=1; } + if (i==6 && tw!=0) { foundid=1; } + if (i==7 && tw!=0) { foundsec=1; } + if (i==8 && tw!=0) { foundpwd=1; } + } + verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec); +} + +function flip(vf,tf) { + var nw=eval('vf.f'+tf+'.selectedIndex'); + var i; + // picked the all one one name field, reset the other name ones to blank + if (tf==1 && nw!=0) { + for (i=2;i<=5;i++) { + eval('vf.f'+i+'.selectedIndex=0;') + } + } + //picked one of the piecewise name fields, reset the all in + //one field to blank + if ((tf>=2) && (tf<=5) && (nw!=0)) { + eval('vf.f1.selectedIndex=0;') + } + // intial password specified, pick internal authentication + if (tf==8 && nw!=0) { + changed_radio('int',document.studentform); + set_auth_radio_buttons('int',document.studentform); + vf.krbarg.value=''; + vf.intarg.value=''; + vf.locarg.value=''; } } -function clickkrb(vf) { - vf.krbdom.value='$krbdefdom'; - clearpwd(vf); - vf.intpwd.value=''; +function clearpwd(vf) { + var i; + if (eval('vf.f8.selectedIndex')!=0) { + eval('vf.f8.selectedIndex=0;') + } +} +ENDPICK } -function clickint(vf) { - vf.krbdom.value=''; +############################################################### +############################################################### +sub print_upload_manager_footer { + my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_; + 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); + my $domform = &domain_form($defdom); + $r->print(< + + +

Login Type

+

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

+

+$krbform +

+

+$intform +

+

+$locform +

+

LON-CAPA Domain for Students

+LON-CAPA domain: $domform

+

Starting and Ending Dates

+ + + + + +Set Starting Date

+ +Set Ending Date

+

Full Update

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

+

ID/Student Number

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

+
+Note: for large courses, this operation may be time consuming. +ENDPICK +} + +# ======================================================= Menu Phase Two Upload +sub print_upload_manager_form { + my $r=shift; + + my $datatoken; + if (!$ENV{'form.datatoken'}) { + $datatoken=&Apache::loncommon::upfile_store($r); + } else { + $datatoken=$ENV{'form.datatoken'}; + &Apache::loncommon::load_tmp_file($r); + } + 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'); + &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom); + my $i; + my $keyfields; + if ($total>=0) { + my @d=(['username','Username'], + ['names','Last Name, First Names'], + ['fname','First Name'], + ['mname','Middle Names/Initials'], + ['lname','Last Name'], + ['gen','Generation'], + ['id','ID/Student Number'], + ['sec','Group/Section'], + ['ipwd','Initial Password']); + if ($ENV{'form.upfile_associate'} eq 'reverse') { + &Apache::loncommon::csv_print_samples($r,\@records); + $i=&Apache::loncommon::csv_print_select_table($r,\@records,\@d); + foreach (@d) { $keyfields.=$_->[0].','; } + chop($keyfields); + } else { + unshift(@d,['none','']); + $i=&Apache::loncommon::csv_samples_select_table($r,\@records,\@d); + my %sone=&Apache::loncommon::record_sep($records[0]); + $keyfields=join(',',sort(keys(%sone))); + } + } + &print_upload_manager_footer($r,$i,$keyfields,$defdom,$today,$halfyear); } +# ======================================================= Enroll single student +sub enroll_single_student { + my $r=shift; + $r->print('

Enrolling Student

'); + $r->print('

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

'); + if (($ENV{'form.cuname'})&&($ENV{'form.cuname'}!~/\W/)&& + ($ENV{'form.lcdomain'})&&($ENV{'form.lcdomain'}!~/\W/)) { + # Deal with home server selection + my $domain=$ENV{'form.lcdomain'}; + my $desiredhost = $ENV{'form.lcserver'}; + if (lc($desiredhost) eq 'default') { + $desiredhost = undef; + } else { + 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 :") if (defined($desiredhost)); + # End of home server selection logic + my $amode=''; + my $genpwd=''; + if ($ENV{'form.login'} eq 'krb') { + $amode='krb'; + $amode.=$ENV{'form.krbver'}; + $genpwd=$ENV{'form.krbarg'}; + } elsif ($ENV{'form.login'} eq 'int') { + $amode='internal'; + $genpwd=$ENV{'form.intarg'}; + } elsif ($ENV{'form.login'} eq 'loc') { + $amode='localauth'; + $genpwd=$ENV{'form.locarg'}; + if (!$genpwd) { $genpwd=" "; } + } + my $home = &Apache::lonnet::homeserver($ENV{'form.cuname'}, + $ENV{'form.lcdomain'}); + if ((($amode) && ($genpwd)) || ($home ne 'no_host')) { + # Clean out any old roles the student has in this class. + &modifystudent($ENV{'form.lcdomain'},$ENV{'form.cuname'}, + $ENV{'request.course.id'},$ENV{'form.csec'}, + $desiredhost); + my $login_result = &Apache::lonnet::modifystudent + ($ENV{'form.lcdomain'},$ENV{'form.cuname'}, + $ENV{'form.cstid'},$amode,$genpwd, + $ENV{'form.cfirst'},$ENV{'form.cmiddle'}, + $ENV{'form.clast'},$ENV{'form.cgen'}, + $ENV{'form.csec'},$ENV{'form.enddate'}, + $ENV{'form.startdate'},$ENV{'form.forceid'}, + $desiredhost); + if ($login_result =~ /^ok/) { + $r->print($login_result); + $r->print("

If active, the new role will be available ". + "when the student next logs in to LON-CAPA.

"); + } else { + $r->print("unable to enroll: ".$login_result); + } + } else { + $r->print('

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

'); + } + } else { + $r->print('Invalid username or domain'); + } +} + +# ======================================================= 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 $krbform = &Apache::loncommon::authform_kerberos(%param); + my $intform = &Apache::loncommon::authform_internal(%param); + my $locform = &Apache::loncommon::authform_local(%param); + # Set up domain selection form + my $domform = &domain_form($defdom); + # Print it all out + $r->print(< + + + - -ENDPICK - my @sone; my @stwo; my @sthree; my $nfields=0; - if ($#lines>=0) { - $lines[0]=~s/^$remove//; - $lines[0]=~s/$remove$//; - @sone=split(/$separator/,$lines[0]); - $nfields=$#sone; - if ($#lines>=1) { - $lines[1]=~s/^$remove//; - $lines[1]=~s/$remove$//; - @stwo=split(/$separator/,$lines[1]); - $nfields=$#stwo; - } - if ($#lines>=2) { - $lines[2]=~s/^$remove//; - $lines[2]=~s/$remove$//; - @sthree=split(/$separator/,$lines[2]); - $nfields=$#sthree; - } - my $i; - for ($i=0;$i<=$nfields;$i++) { - $r->print(''); - } - } - $r->print(<Personal Data +
FieldSamples
'); - if (defined($sone[$i])) { - $r->print($sone[$i]."
\n"); - } - if (defined($stwo[$i])) { - $r->print($stwo[$i]."
\n"); - } - if (defined($sthree[$i])) { - $r->print($sthree[$i]."
\n"); - } - $r->print('
+ + + +
First Name:
Middle Name:
Last Name:
Generation:
- -

Login Type

- -Kerberos authenticated with domain -

- -Internally authenticated (with initial password -)

- -ENDPICK - } elsif ($ENV{'form.enroll'}) { - } elsif ($ENV{'form.drop'}) { - } - } -# ----------------------------------------------------------------- Phase three - if ($ENV{'form.phase'} eq 'three') { - if ($ENV{'form.datatoken'}) { - my $separator=''; - my $remove=''; - if ($ENV{'form.upfiletype'} eq 'csv') { - $separator='\"\,\s*\"'; - $remove='"'; - } elsif ($ENV{'form.upfiletype'} eq 'space') { - $separator='\s+'; - } elsif ($ENV{'form.upfiletype'} eq 'tab') { - $separator='\t+'; - } elsif ($ENV{'form.upfiletype'} eq 'xml') { - } - map { - my $line=$_; - $line=~s/^$remove//; - $line=~s/$remove$//; - my @entries=split(/$separator/,$line); - $r->print($entries[8].'
'); - } split(/\n/, - &Apache::lonnet::unescape(Apache::lonnet::reply( - 'tmpget:'.$ENV{'form.datatoken'},$r->dir_config('lonHostID'))) - ); - - } - } -# ------------------------------------------------------------------------- End - $r->print('

'); - } 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; - } - return OK; + +

Login Data

+

Username:

+

Domain: $domform

+

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

+$krbform +

+$intform +

+$locform +

+ +

Course Data

+ +

Group/Section: +

+ + + + + + +

+Set Starting Date +

+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) +

+ +

+END + return; } -1; -__END__ +# ========================================================= Menu Phase Two Drop +sub print_drop_menu { + my $r=shift; + $r->print("

Drop Students

"); + 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"); + return; + } + # Print out the available choices + &show_drop_list($r,$classlist,$keylist); + return; +} + +# ============================================== view classlist +sub print_html_classlist { + my $r=shift; + if (! exists($ENV{'form.sortby'})) { + $ENV{'form.sortby'} = 'username'; + } + if (! exists($ENV{'form.Status'}) || + $ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { + $ENV{'form.Status'} = 'Active'; + } + my $status_select = &Apache::lonhtmlcommon::StatusOptions + ($ENV{'form.Status'},'studentform'); + $r->print(< + +

+Current Classlist +      + +CSV format + +      +$status_select +

+END + 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 { + # Print out the available choices + if ($ENV{'form.action'} eq 'modifystudent') { + &show_class_list($r,'view','modify','modifystudent', + $ENV{'form.Status'},$classlist,$keylist); + } else { + &show_class_list($r,'view','aboutme','classlist', + $ENV{'form.Status'},$classlist,$keylist); + } + } +} + +# ============================================== view classlist +sub print_csv_classlist { + my $r=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', + $ENV{'form.Status'},$classlist,$keylist); + } +} + +# =================================================== Show student list to drop +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']); + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id)$/) { + $sortby = 'username'; + } + # Print out header + if ($mode eq 'view') { + if ($linkto eq 'aboutme') { + $r->print('Select a user name to view the users personal 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"); + } + # + # Sort the students + my %index; + my $i; + foreach (@$keylist) { + $index{$_} = $i++; + } + my $index = $index{$sortby}; + my $second = $index{'username'}; + my $third = $index{'domain'}; + my @Sorted_Students = sort { + lc($classlist->{$a}->[$index]) cmp lc($classlist->{$b}->[$index]) + || + lc($classlist->{$a}->[$second]) cmp lc($classlist->{$b}->[$second]) + || + lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third]) + } (keys(%$classlist)); + foreach my $student (@Sorted_Students) { + my $username = $classlist->{$student}->[$index{'username'}]; + my $domain = $classlist->{$student}->[$index{'domain'}]; + my $section = $classlist->{$student}->[$index{'section'}]; + my $name = $classlist->{$student}->[$index{'fullname'}]; + my $id = $classlist->{$student}->[$index{'id'}]; + my $status = $classlist->{$student}->[$index{'status'}]; + next if (($statusmode ne 'Any') && ($status ne $statusmode)); + 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('
+ username + + domain + + ID + + student name + + section +
\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','sortby']); + my $sname = $ENV{'form.sname'}; + my $sdom = $ENV{'form.sdom'}; + my $sortby = $ENV{'form.sortby'}; + # determine the students name information + my %info=&Apache::lonnet::get('environment', + ['firstname','middlename', + 'lastname','generation','id'], + $sdom, $sname); + my ($tmp) = keys(%info); + if ($tmp =~ /^(con_lost|error|no_such_host)/i) { + $r->print('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(< + +Only domain coordinators can change a users password. + +

+ + + + + +

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

+

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

+Student ID: +

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

+Section: +

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

+ + +END + return; +} + +# +# modify a single students section +# +sub modify_single_student { + my $r = shift; + # Get the 'sortby' variable so the user does not need to re-sort + my $sortby = $ENV{'form.sortby'}; + # + # We always need this information + my $slogin = $ENV{'form.slogin'}; + my $sdom = $ENV{'form.sdomain'}; + # + # Get the old data + my %old=&Apache::lonnet::get('environment', + ['firstname','middlename', + 'lastname','generation','id'], + $sdom, $slogin); + my ($tmp) = keys(%old); + if ($tmp =~ /^(con_lost|error|no_such_host)/i) { + $r->print("There was an error determining the environment values ". + " for $slogin \@ $sdom."); + return; + } + undef $tmp; + # + # Get the new data + my $firstname = $ENV{'form.firstname'}; + my $middlename = $ENV{'form.middlename'}; + my $lastname = $ENV{'form.lastname'}; + my $generation = $ENV{'form.generation'}; + my $section = $ENV{'form.section'}; + my $courseid = $ENV{'request.course.id'}; + my $sid = $ENV{'form.id'}; + my $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'}))) { + $r->print("You changed the students id ". + " but did not disable the ID change safeguard.". + " The students id will not be changed."); + $sid = $old{'id'}; + } + # + # talk to the user about what we are going to do + $r->print(<Modifying data for user $slogin \@ $sdom +

Student Information

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Old Value New Value
First name $old{'firstname'} $firstname
Middle name $old{'middlename'} $middlename
Last name $old{'lastname'} $lastname
Generation $old{'generation'} $generation
ID $old{'id'} $sid
+

Role Information

+ + + + +
Section $section
Start Time $displayable_starttime
End Time $displayable_endtime
+

+END + # + # Send request(s) to modify data + my $roleresults = &Apache::lonnet::modifystudent + ($sdom,$slogin,$sid,undef,undef,$firstname,$middlename,$lastname, + $generation,$section,$endtime,$starttime,$ENV{'form.forceid'}); + if ($roleresults eq 'refused' ) { + $r->print("Your request to change the role information for this ". + "student was refused. You do not appear to have ". + "sufficient authority to change student information."); + } elsif ($roleresults !~ /ok/) { + $r->print("An error occurred during the attempt to change the role". + " information for this student.
". + "The error reported was ". + $roleresults); + &Apache::lonnet::logthis("londropadd:failed attempt to modify student". + " data for ".$slogin." \@ ".$sdom." by ". + $ENV{'user.name'}." \@ ".$ENV{'user.domain'}. + ":".$roleresults); + } else { # everything is okay! + $r->print("Student information updated successfully.
". + "The student must log out and log in again to see ". + "these changes."); + } + $r->print(<

+Modify another students data + +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); +} + +################################################# +################################################# + +=pod + +=item show_drop_list + +Display a list of students to drop +Inputs: +=over 4 +=item $r, Apache request + +=item $classlist, hash pointer returned from loncoursedata::get_classlist(); + +=item $keylist, array pointer returned from loncoursedata::get_classlist() +which describes the order elements are stored in the %$classlist values. + +=item $nosort, if true, sorting links are omitted. + +=back + +=cut + +################################################# +################################################# +sub show_drop_list { + my ($r,$classlist,$keylist,$nosort)=@_; + my $cid=$ENV{'request.course.id'}; + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sortby']); + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id)$/) { + $sortby = 'username'; + } + # + my $action = "drop"; + $r->print(< + + + +

+ +END + + if ($nosort) { + $r->print(< + +   + username + domain + ID + student name + section + +END + + } else { + $r->print(< +  + + username + + domain + + ID + + student name + + section + + +END + } + # + # Sort the students + my %index; + my $i; + foreach (@$keylist) { + $index{$_} = $i++; + } + my $index = $index{$sortby}; + my $second = $index{'username'}; + my $third = $index{'domain'}; + my @Sorted_Students = sort { + lc($classlist->{$a}->[$index]) cmp lc($classlist->{$b}->[$index]) + || + lc($classlist->{$a}->[$second]) cmp lc($classlist->{$b}->[$second]) + || + lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third]) + } (keys(%$classlist)); + foreach my $student (@Sorted_Students) { + my $error; + my $username = $classlist->{$student}->[$index{'username'}]; + my $domain = $classlist->{$student}->[$index{'domain'}]; + my $section = $classlist->{$student}->[$index{'section'}]; + my $name = $classlist->{$student}->[$index{'fullname'}]; + my $id = $classlist->{$student}->[$index{'id'}]; + my $status = $classlist->{$student}->[$index{'status'}]; + next if ($status ne 'Active'); + # + $r->print(<<"END"); + + + $username + $domain + $id + $name + $section + +END + } + $r->print('
'); + $r->print(<<"END"); +

+   + +

+END + return; +} + +# +# Print out the initial form to get the courselist file +# +sub print_first_courselist_upload_form { + my $r=shift; + my $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(< +

Upload a courselist

+$upfile_select +

+ + + +

+$create_classlist_help
+$create_csv_help + +ENDUPFORM + return; +} + +# ================================================= Drop/Add from uploaded file +sub upfile_drop_add { + my $r=shift; + &Apache::loncommon::load_tmp_file($r); + my @studentdata=&Apache::loncommon::upfile_record_sep(); + my @keyfields = split(/\,/,$ENV{'form.keyfields'}); + my $cid = $ENV{'request.course.id'}; + my %fields=(); + for (my $i=0; $i<=$ENV{'form.nfields'}; $i++) { + if ($ENV{'form.upfile_associate'} eq 'reverse') { + if ($ENV{'form.f'.$i} ne 'none') { + $fields{$keyfields[$i]}=$ENV{'form.f'.$i}; + } + } else { + $fields{$ENV{'form.f'.$i}}=$keyfields[$i]; + } + } + # + my $startdate = $ENV{'form.startdate'}; + my $enddate = $ENV{'form.enddate'}; + if ($startdate=~/\D/) { $startdate=''; } + if ($enddate=~/\D/) { $enddate=''; } + # Determine domain and desired host (home server) + my $domain=$ENV{'form.lcdomain'}; + my $desiredhost = $ENV{'form.lcserver'}; + if (lc($desiredhost) eq 'default') { + $desiredhost = undef; + } else { + my %home_servers = &Apache::loncommon::get_library_servers($domain); + if (! exists($home_servers{$desiredhost})) { + $r->print('Error:'. + 'Invalid home server specified'); + return; + } + } + # Determine authentication mechanism + my $amode = ''; + my $genpwd = ''; + if ($ENV{'form.login'} eq 'krb') { + $amode='krb'; + $amode.=$ENV{'form.krbver'}; + $genpwd=$ENV{'form.krbarg'}; + } elsif ($ENV{'form.login'} eq 'int') { + $amode='internal'; + if ((defined($ENV{'form.intarg'})) && ($ENV{'form.intarg'})) { + $genpwd=$ENV{'form.intarg'}; + } + } elsif ($ENV{'form.login'} eq 'loc') { + $amode='localauth'; + if ((defined($ENV{'form.locarg'})) && ($ENV{'form.locarg'})) { + $genpwd=$ENV{'form.locarg'}; + } + } + unless (($domain=~/\W/) || ($amode eq '')) { + ####################################### + ## Enroll Students ## + ####################################### + $r->print('

Enrolling Students

'); + my $count=0; + my $flushc=0; + my %student=(); + # Get new classlist + foreach (@studentdata) { + my %entries=&Apache::loncommon::record_sep($_); + # Determine student name + unless (($entries{$fields{'username'}} eq '') || + (!defined($entries{$fields{'username'}}))) { + my ($fname, $mname, $lname,$gen) = ('','','',''); + if (defined($fields{'names'})) { + ($lname,$fname,$mname)=($entries{$fields{'names'}}=~ + /([^\,]+)\,\s*(\w+)\s*(.*)$/); + } else { + if (defined($fields{'fname'})) { + $fname=$entries{$fields{'fname'}}; + } + if (defined($fields{'mname'})) { + $mname=$entries{$fields{'mname'}}; + } + if (defined($fields{'lname'})) { + $lname=$entries{$fields{'lname'}}; + } + if (defined($fields{'gen'})) { + $gen=$entries{$fields{'gen'}}; + } + } + if ($entries{$fields{'username'}}=~/\W/) { + $r->print('

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

'); + } else { + # determine section number + my $sec=''; + my $username=$entries{$fields{'username'}}; + if (defined($fields{'sec'})) { + if (defined($entries{$fields{'sec'}})) { + $sec=$entries{$fields{'sec'}}; + } + } + # determine student id number + my $id=''; + if (defined($fields{'id'})) { + if (defined($entries{$fields{'id'}})) { + $id=$entries{$fields{'id'}}; + } + $id=~tr/A-Z/a-z/; + } + # determine student password + my $password=''; + if ($genpwd) { + $password=$genpwd; + } else { + if (defined($fields{'ipwd'})) { + if ($entries{$fields{'ipwd'}}) { + $password=$entries{$fields{'ipwd'}}; + } + } + } + # Clean up whitespace + foreach (\$domain,\$username,\$id,\$fname,\$mname, + \$lname,\$gen,\$sec) { + $$_ =~ s/(\s+$|^\s+)//g; + } + 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); + if ($reply ne 'ok') { + $r->print('

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

'); + } else { + $count++; $flushc++; + $student{$username}=1; + $r->print('. '); + if ($flushc>15) { + $r->rflush; + $flushc=0; + } + } + } else { + $r->print("

No password for $username

"); + } + } + } + } # end of foreach (@studentdata) + $r->print('

Processed Students: '.$count.'

'); + $r->print("

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

"); + ##################################### + # Drop students # + ##################################### + if ($ENV{'form.fullup'} eq 'yes') { + $r->print('

Dropping Students

'); + # Get current classlist + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { + $r->print("There are no students currently enrolled.\n"); + } else { + # Remove the students we just added from the list of students. + foreach (@studentdata) { + my %entries=&Apache::loncommon::record_sep($_); + unless (($entries{$fields{'username'}} eq '') || + (!defined($entries{$fields{'username'}}))) { + delete($classlist->{$entries{$fields{'username'}}. + ':'.$domain}); + } + } + # Print out list of dropped students. + &show_drop_list($r,$classlist,$keylist,'nosort'); + } + } + } # end of unless +} + +# ================================================================== Phase four +sub drop_student_list { + my $r=shift; + my $count=0; + my @droplist; + if (ref($ENV{'form.droplist'})) { + @droplist = @{$ENV{'form.droplist'}}; + } else { + @droplist = ($ENV{'form.droplist'}); + } + foreach (@droplist) { + my ($uname,$udom)=split(/\:/,$_); + # drop student + my $result = &modifystudent($udom,$uname,$ENV{'request.course.id'}); + if ($result eq 'ok' || $result eq 'ok:') { + $r->print('Dropped '.$uname.' @ '.$udom.'
'); + } else { + $r->print('Error dropping '.$uname.' @ '.$udom.': '.$result. + '
'); + } + $count++; + } + $r->print('

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

Re-enrollment will re-activate data.'); +} + +################################################################### +################################################################### + +=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) { + $r->content_type('text/html'); + $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'})))) { + # 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()); + } + # + # 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); + } + } 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 { + &print_drop_menu($r); + } + } 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); + } + } 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 { + # 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(''); + } + return OK; +} + +################################################################### +################################################################### + +1; +__END__