# The LearningOnline Network with CAPA
# Handler to drop and add students in courses
#
# $Id: londropadd.pm,v 1.52 2002/09/24 18:24:43 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
# 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.
#
# 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
#
# (Handler to resolve ambiguous file locations
#
# (TeX Content Handler
#
###############################################################
###############################################################
package Apache::londropadd;
use strict;
use Apache::lonnet();
use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::Constants qw(:common :http REDIRECT);
###############################################################
###############################################################
sub header {
my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager');
return(<<ENDHEAD);
<html>
<head>
<title>LON-CAPA Enrollment Manager</title>
</head>
$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
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(<<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 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(<<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="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'}" />
<input type="hidden" name="upfile_associate"
value="$ENV{'form.upfile_associate'}" />
<hr />
<script type="text/javascript" language="Javascript">
$javascript
$javascript_validations
</script>
ENDPICK
}
###############################################################
###############################################################
sub javascript_validations {
my ($krbdefdom)=@_;
my %param = ( formname => 'studentform',
kerb_def_dom => $krbdefdom );
my $authheader = &Apache::loncommon::authform_header(%param);
return (<<ENDPICK);
function verify_message (vf,founduname,foundpwd,foundname,foundid,foundsec) {
var foundatype=0;
var message='';
if (founduname==0) {
alert('You need to specify the username field');
return;
}
if (current.radiovalue == null || current.radiovalue == 'nochange') {
// They did not check any of the login radiobuttons.
alert('You must choose an authentication type');
return;
}
foundatype=1;
if (current.argfield == null || current.argfield == '') {
var alertmsg = '';
switch (current.value) {
case 'krb':
alertmsg = 'You need to specify the Kerberos domain';
break;
case 'loc':
case 'fsys':
alertmsg = 'You need to specify the initial password';
break;
case 'fsys':
alertmsg = '';
break;
default:
alertmsg = '';
}
if (alertmsg != '') {
alert(alertmsg);
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. '; }
if (vf.startdate.value=='') {
message+='No starting date set. ';
}
if (vf.enddate.value=='') {
message+='No ending date set. ';
}
if ((vf.enddate.value!='') && (vf.startdate.value!='')) {
if (Math.round(vf.enddate.value)<Math.round(vf.startdate.value)) {
alert('Ending date is before starting date');
return;
}
}
if (message!='') {
message+='Continue enrollment?';
if (confirm(message)) {
pclose();
vf.state.value='enrolling';
vf.submit();
}
} else {
pclose();
vf.state.value='enrolling';
vf.submit();
}
}
function pclose() {
parmwin=window.open("/adm/rat/empty.html","LONCAPAparms",
"height=350,width=350,scrollbars=no,menubar=no");
parmwin.close();
}
function pjump(type,dis,value,marker,ret,call) {
parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
+"&value="+escape(value)+"&marker="+escape(marker)
+"&return="+escape(ret)
+"&call="+escape(call)+"&name="+escape(dis),"LONCAPAparms",
"height=350,width=350,scrollbars=no,menubar=no");
}
function dateset() {
if (document.studentform.pres_marker.value=='end') {
document.studentform.enddate.value=
document.studentform.pres_value.value;
}
if (document.studentform.pres_marker.value=='start') {
document.studentform.startdate.value=
document.studentform.pres_value.value;
}
pclose();
}
$authheader
ENDPICK
}
###############################################################
###############################################################
sub upload_manager_javascript_forward_associate {
return(<<ENDPICK);
function verify(vf) {
var founduname=0;
var foundpwd=0;
var foundname=0;
var foundid=0;
var foundsec=0;
var tw;
for (i=0;i<=vf.nfields.value;i++) {
tw=eval('vf.f'+i+'.selectedIndex');
if (tw==1) { founduname=1; }
if ((tw>=2) && (tw<=6)) { foundname=1; }
if (tw==7) { foundid=1; }
if (tw==8) { foundsec=1; }
if (tw==9) { foundpwd=1; }
}
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 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) {
changed_radio('int',document.studentform);
set_auth_radio_buttons('int',document.studentform);
vf.intarg.value='';
vf.krbarg.value='';
vf.locarg.value='';
}
}
function clearpwd(vf) {
var i;
for (i=0;i<=vf.nfields.value;i++) {
if (eval('vf.f'+i+'.selectedIndex')==9) {
eval('vf.f'+i+'.selectedIndex=0;')
}
}
}
ENDPICK
}
###############################################################
###############################################################
sub upload_manager_javascript_reverse_associate {
return(<<ENDPICK);
function verify(vf) {
var founduname=0;
var foundpwd=0;
var foundname=0;
var foundid=0;
var foundsec=0;
var tw;
for (i=0;i<=vf.nfields.value;i++) {
tw=eval('vf.f'+i+'.selectedIndex');
if (i==0 && tw!=0) { founduname=1; }
if (((i>=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 clearpwd(vf) {
var i;
if (eval('vf.f8.selectedIndex')!=0) {
eval('vf.f8.selectedIndex=0;')
}
}
ENDPICK
}
###############################################################
###############################################################
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(<<ENDPICK);
</table>
<input type=hidden name=nfields value=$i>
<input type=hidden name=keyfields value="$keyfields">
<h3>Login Type</h3>
<p>Note: this will not take effect if the user already exists</p>
<p>
$krbform
</p>
<p>
$intform
</p>
<p>
$locform
</p>
<h3>LON-CAPA Domain for Students</h3>
LON-CAPA domain: $domform <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" >
<a
href="javascript:pjump('date_start','Enrollment Starting Date',document.studentform.startdate.value,'start','studentform.pres','dateset');"
>Set Starting Date</a><p>
<a
href="javascript:pjump('date_end','Enrollment Ending Date',document.studentform.enddate.value,'end','studentform.pres','dateset');"
>Set Ending Date</a><p>
<h3>Full Update</h3>
<input type=checkbox name=fullup value=yes> Full update
(also print list of users not enrolled anymore)<p>
<h3>ID/Student Number</h3>
<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="javascript:verify(this.form)" value="Update Courselist" /><br />
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('<h3>Enrolling Student</h3>');
$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
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('<font color="#ff0000">Error:</font>'.
'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')) {
&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,
$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));
} else {
$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');
}
}
# ======================================================= 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;
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(<<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;
var foundpwd=0;
var foundname=0;
var foundid=0;
var foundsec=0;
var tw;
if ((typeof(vf.cuname.value) !="undefined") && (vf.cuname.value!='') &&
(typeof(vf.lcdomain.value)!="undefined") && (vf.lcdomain.value!='')) {
founduname=1;
}
if ((typeof(vf.cfirst.value)!="undefined") && (vf.cfirst.value!='') &&
(typeof(vf.clast.value) !="undefined") && (vf.clast.value!='')) {
foundname=1;
}
if ((typeof(vf.csec.value)!="undefined") && (vf.csec.value!='')) {
foundsec=1;
}
if ((typeof(vf.cstid.value)!="undefined") && (vf.cstid.value!='')) {
foundid=1;
}
if (founduname==0) {
alert('You need to specify at least the username and domain fields');
return;
}
verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec);
}
$javascript_validations
function clearpwd(vf) {
//nothing else needs clearing
}
</script>
<h3>Personal Data</h3>
<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>
<p>Domain: $domform</p>
<p>Note: login settings below will not take effect if the user already exists
</p><p>
$krbform
</p><p>
$intform
</p><p>
$locform
</p><p>
<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');"
>Set Starting Date</a>
</p><p>
<a
href="javascript:pjump('date_end','Enrollment Ending Date',document.studentform.enddate.value,'end','studentform.pres','dateset');"
>Set Ending Date</a>
</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><p>
<input type="button" onClick="verify(this.form)" value="Enroll as student">
</p>
END
return;
}
# =================================================== get the current classlist
sub get_current_classlist {
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 print_drop_menu {
my $r=shift;
$r->print("<h3>Drop Students</h3>");
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");
return;
}
# 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
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 ($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) {
for (i = 0; i < field.length; i++)
field[i].checked = true ;
}
function uncheckAll(field) {
for (i = 0; i < field.length; i++)
field[i].checked = false ;
}
</script>
<p>
<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>section</th></tr>
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="$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");
</p><p>
<input type="button" value="check all" onclick="javascript:checkAll(document.studentform.droplist)">
<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
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('<font color="#ff0000">Error:</font>'.
'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('<h3>Enrolling Students</h3>');
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('<p><b>Unacceptable username: '.
$entries{$fields{'username'}}.' for user '.
$fname.' '.$mname.' '.$lname.' '.$gen.'</b><p>');
} 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'}};
}
}
}
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('<p><b>'.
'Error enrolling '.$username.': '.
$reply.'</b></p>');
} else {
$count++; $flushc++;
$student{$username}=1;
$r->print('. ');
if ($flushc>15) {
$r->rflush;
$flushc=0;
}
}
} else {
$r->print("<p><b>No password for $username</b><p>");
}
}
}
} # end of foreach (@studentdata)
$r->print('<p>Processed Students: '.$count);
#####################################
# Drop students #
#####################################
if ($ENV{'form.fullup'} eq 'yes') {
$r->print('<h3>Dropping Students</h3>');
# Get current classlist
my ($error,%currentlist)=&get_current_classlist($r);
if (defined($error)) {
$r->print('<pre>ERROR:$error</pre>');
}
if (defined(%currentlist)) {
# Drop the students
foreach (@studentdata) {
my %entries=&Apache::loncommon::record_sep($_);
unless (($entries{$fields{'username'}} eq '') ||
(!defined($entries{$fields{'username'}}))) {
delete($currentlist{$entries{$fields{'username'}}.
':'.$domain});
}
}
# Print out list of dropped students
&show_drop_list($r,%currentlist);
} else {
$r->print("There are no students currently enrolled.\n");
}
}
} # 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;
my @droplist;
if (ref($ENV{'form.droplist'})) {
@droplist = @{$ENV{'form.droplist'}};
} else {
@droplist = ($ENV{'form.droplist'});
}
foreach (@droplist) {
my ($uname,$udom)=split(/\:/,$_);
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.');
}
###################################################################
###################################################################
=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 {
&menu_phase_two_drop($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('</form></body></html>');
}
return OK;
}
###################################################################
###################################################################
1;
__END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to londropadd.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface