File:  [LON-CAPA] / loncom / interface / Attic / londropadd.pm
Revision 1.77: download - view: text, annotated - select for diffs
Fri Jul 25 18:05:06 2003 UTC (20 years, 9 months ago) by matthew
Branches: MAIN
CVS tags: HEAD
For inclusion in 1.0.  Section names with spaces in them cause problems,
so trap and silently remove them.

# The LearningOnline Network with CAPA
# Handler to drop and add students in courses 
#
# $Id: londropadd.pm,v 1.77 2003/07/25 18:05:06 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);
use Spreadsheet::WriteExcel;

###############################################################
###############################################################
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 eq $csec) {
                $result .= 'ok:';
            } elsif ( ((!$section) && (!$csec)) || ($section ne $csec) ) {
                my (undef,$end,$start)=split(/\_/,$roles{$course});
                my $now=time;
                # if this is an active role 
                if (!($start && ($now<$start)) || !($end && ($now>$end))) {
                    my $reply=&Apache::lonnet::modifystudent
                        # dom  name  id mode pass     f     m     l     g
                        ($udom,$unam,'',  '',  '',undef,undef,undef,undef,
                         $section,time,undef,undef,$desiredhost);
                    $result .= $reply.':';
                }
            }
        }
    }
    if ($result eq '') {
        $result = '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 Class List</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);
    my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
    return (<<ENDPICK);
function verify_message (vf,founduname,foundpwd,foundname,foundid,foundsec,foundemail) {
    var foundatype=0;
    var message='';
    if (founduname==0) {
	alert('You need to specify the username field');
        return;
    }
    // alert('current.radiovalue = '+current.radiovalue);
    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='name fields'; }
    if (foundid==0) { if (message!='') { message+=', '; } message+='student number field'; }
    if (foundsec==0) {  if (message!='') { message+=', '; } message+='section or group field'; }
    if (foundemail==0) {  if (message!='') { message+=', '; } message+='email address field'; }
    if (message!='') {
       message='Not specified (optional): '+message+'.  Continue enrollment?';
       if (confirm(message)) {
          vf.state.value='enrolling';
	  vf.submit();
       }
    } else {
      vf.state.value='enrolling';
      vf.submit();
    }
}

$authheader
ENDPICK

}

sub javascript_validations_without_auth {
    my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
    return (<<ENDPICK);
function verify_message (vf,founduname,foundpwd,foundname,foundid,foundsec,foundemail) {
    var foundatype=0;
    var message='';
    if (founduname==0) {
	alert('You need to specify the username field');
        return;
    }
    if (foundname==0) { message='name fields'; }
    if (foundid==0) { if (message!='') { message+=', '; } message+='student number field'; }
    if (foundsec==0) {  if (message!='') { message+=', '; } message+='section or group field'; }
    if (foundemail==0) {  if (message!='') { message+=', '; } message+='email address field'; }
    if (message!='') {
       message='Not specified (optional): '+message+'.  Continue enrollment?';
       if (confirm(message)) {
          vf.state.value='enrolling';
	  vf.submit();
       }
    } else {
      vf.state.value='enrolling';
      vf.submit();
    }
}

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 foundemail=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; }
        if (tw==10) { foundemail=1; }
    }
    verify_message(vf,founduname,foundpwd,foundname,foundid,foundsec,foundemail);
}

//
// 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)
// 10 = email address

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 ($krbdef,$krbdefdom) =
        &Apache::loncommon::get_kerberos_defaults($defdom);
    my %param = ( formname => 'document.studentform',
                  kerb_def_dom => $krbdefdom,
                  kerb_def_auth => $krbdef
                  );
    my $krbform = &Apache::loncommon::authform_kerberos(%param);
    my $intform = &Apache::loncommon::authform_internal(%param);
    my $locform = &Apache::loncommon::authform_local(%param);
    my $domform = &domain_form($defdom);
    my $date_table = &date_setting_table();
    $r->print(<<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>
<p>
$date_table
</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;
    my $today=time;
    my $halfyear=$today+15552000;
    my $defdom=$r->dir_config('lonDefDomain');
    my ($krbdef,$krbdefdom) =
        &Apache::loncommon::get_kerberos_defaults($defdom);
    &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom);
    my $i;
    my $keyfields;
    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'],
               ['email','EMail Address']);
	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;
    # Remove whitespace from section
    $ENV{'form.csec'}=~s/\s//g;
    #
    # We do the dates first because the action of making them the defaul
    # in the course is entirely seperate from the action of enrolling the
    # student.  Also, a failure in setting the dates as default is not fatal
    # to the process of enrolling / modifying a student.
    my ($startdate,$enddate) = &get_dates_from_form();
    if ($ENV{'form.makedatesdefault'}) {
        $r->print(&make_dates_default($startdate,$enddate));
    }

    $r->print('<h3>Enrolling Student</h3>');
    $r->print('<p>Enrolling '.$ENV{'form.cuname'}." \@ ".
              $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')) {
            # 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'},$enddate,
                 $startdate,$ENV{'form.forceid'},
                 $desiredhost);
            if ($login_result =~ /^ok/) {
                $r->print($login_result);
                $r->print("<p> If active, the new role will be available ".
                          "when the student next logs in to LON-CAPA.</p>");
            } else {
                $r->print("unable to enroll: ".$login_result);
            }
	} else {
            $r->print('<p><font color="#ff0000">ERROR</font>&nbsp;'.
                      'Invalid login mode or password.  '.
                      'Unable to enroll '.$ENV{'form.cuname'}.'.</p>');
        }          
    } else {
        $r->print('Invalid username or domain');
    }    
}

sub setup_date_selectors {
    my ($starttime,$endtime) = @_;
    if (! defined($starttime)) {
        $starttime = time;
        if (exists($ENV{'course.'.$ENV{'request.course.id'}.
                            '.default_enrollment_start_date'})) {
            $starttime = $ENV{'course.'.$ENV{'request.course.id'}.
                                  '.default_enrollment_start_date'};
        }
    }
    if (! defined($endtime)) {
        $endtime = time+(6*30*24*60*60); # 6 months from now, approx
        if (exists($ENV{'course.'.$ENV{'request.course.id'}.
                            '.default_enrollment_end_date'})) {
            $endtime = $ENV{'course.'.$ENV{'request.course.id'}.
                                '.default_enrollment_end_date'};
        }
    }
    my $startdateform = &Apache::lonhtmlcommon::date_setter('studentform',
                                                            'startdate',
                                                            $starttime);
    my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform',
                                                          'enddate',
                                                          $endtime);
    return ($startdateform,$enddateform);
}

sub get_dates_from_form {
    my $startdate = &Apache::lonhtmlcommon::get_date_from_form('startdate');
    my $enddate   = &Apache::lonhtmlcommon::get_date_from_form('enddate');
    if ($ENV{'form.no_end_date'}) {
        $enddate = 0;
    }
    return ($startdate,$enddate);
}

sub date_setting_table {
    my ($starttime,$endtime) = @_;
    my ($startform,$endform)=&setup_date_selectors($starttime,$endtime);
    my $dateDefault = '<nobr>'.
        '<input type="checkbox" name="makedatesdefault" />'.
        ' make these dates the default for future enrollment';
    my $perpetual = '<nobr><input type="checkbox" name="no_end_date"';
    if (defined($endtime) && $endtime == 0) {
        $perpetual .= ' checked';
    }
    $perpetual.= ' />'.' no ending date</nobr>';
    my $result = '';
    $result .= "<table>\n";
    $result .= '<tr><td align="right">Starting Date</td>'.
        '<td>'.$startform.'</td>'.
        '<td>'.$dateDefault.'</td>'."</tr>\n";
    $result .= '<tr><td align="right">Ending Date</td>'.
        '<td>'.$endform.'</td>'.
        '<td>'.$perpetual.'</td>'."</tr>\n";
    $result .= "</table>\n";
    return $result;
}

sub make_dates_default {
    my ($startdate,$enddate) = @_;
    my $result = '';
    my $dom = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
    my $crs = $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
    my $put_result = &Apache::lonnet::put('environment',
            {'default_enrollment_start_date'=>$startdate,
             'default_enrollment_end_date'  =>$enddate},$dom,$crs);
    if ($put_result eq 'ok') {
        $result .= "Set default start and end dates for course<br />";
        #
        # Refresh the course environment
        &Apache::lonnet::coursedescription($ENV{'request.course.id'});
    } else {
        $result .= "Unable to set default dates for course:".$put_result.
            '<br />';
    }
    return $result;
}

##
## Single student enrollment routines (some of them)
##
sub get_student_username_domain_form {
    my $r = shift;
    my $domform = &Apache::loncommon::select_dom_form
        ($r->dir_config('lonDefDomain'),'cudomain',0);
    $r->print(<<END);
<input type="hidden" name="action" value="enrollstudent" />
<input type="hidden" name="state"  value="gotusername" />
<h3>Enroll One Student</h3>
<table>
<tr><th>Username:</th>
    <td><input type="text" name="cuname"  size="15" /></td></tr>
<tr><th>Domain:</th>
    <td>$domform</td></tr>
<tr><th>&nbsp;</th>
    <td>
    <input type="submit" name="Begin Enrollment" value="Begin Enrollment" />
    </td></tr>
</table>
END
    return;
}

sub print_enroll_single_student_form {
    my $r=shift;
    $r->print("<h3>Enroll One Student</h3>");
    #
    my $username = $ENV{'form.cuname'};
    my $domain   = $ENV{'form.cudomain'};
    my $home = &Apache::lonnet::homeserver($username,$domain);
    # $new_user flags whether we are creating a new user or using an old one
    my $new_user = 1;
    if ($home ne 'no_host') {
        $new_user = 0;
    }
    &Apache::lonnet::logthis('home = '.$home);
    #
    my $user_data_html = '';
    my $javascript_validations = '';
    if ($new_user) {
        my $defdom=$r->dir_config('lonDefDomain');
        # Set up authentication forms
        my ($krbdef,$krbdefdom) =
            &Apache::loncommon::get_kerberos_defaults($domain);
        $javascript_validations=&javascript_validations($krbdefdom);
        my %param = ( formname => 'document.studentform',
                      kerb_def_dom => $krbdefdom,
                      kerb_def_auth => $krbdef
                      );
        my $krbform = &Apache::loncommon::authform_kerberos(%param);
        my $intform = &Apache::loncommon::authform_internal(%param);
        my $locform = &Apache::loncommon::authform_local(%param);
        #
        # Set up domain selection form
        my $homeserver_form = '';
        my %servers = &Apache::loncommon::get_library_servers($domain);
        $homeserver_form = '<select name="lcserver" size="1">'."\n".
            '<option value="default" selected>default</option>'."\n";
        while (my ($servername,$serverdescription) = each (%servers)) {
            $homeserver_form .= '<option value="'.$servername.'">'.
                $serverdescription."</option>\n";
        }
        $homeserver_form .= "</select>\n";
        #
        #
        $user_data_html = <<END;
<h3>User Data for $username\@$domain</h3>
<table>
<tr><th>First Name:</th>
    <td><input type="text" name="cfirst"  size="15"></td></tr>
<tr><th>Middle Name:</th>
    <td><input type="text" name="cmiddle" size="15"></td></tr>
<tr><th>Last Name:</th>
    <td><input type="text" name="clast"   size="15"></td></tr>
<tr><th>Generation:</th>
    <td><input type="text" name="cgen"    size="5"> </td></tr>
<tr><th>Home Server:</th>
    <td>$homeserver_form</td></tr>
</table>
<h3>Password</h3>
Please select an authentication mechanism
<table>
<p>
$krbform
<br />
$intform
<br />
$locform
</p>
END
    } else {
        # User already exists.  Do not worry about authentication
        my %uenv = &Apache::lonnet::dump('environment',$domain,$username);
        $javascript_validations = &javascript_validations_without_auth();
        $user_data_html = <<END;
<h3>User Data for $username\@$domain</h3>
<input type="hidden" name="lcserver" value="default" />
<table>
<tr><th>First Name:</th>
    <td>
    <input type="text" name="cfirst" value="$uenv{'firstname'}" size="15" />
    </td></tr>
<tr><th>Middle Name:</th>
    <td>
    <input type="text" name="cmiddle" value="$uenv{'middlename'}" size="15" />
    </td></tr>
<tr><th>Last Name:</th>
    <td>
    <input type="text" name="clast"value="$uenv{'lastname'}" size="15" />
    </td></tr>
<tr><th>Generation:</th>
    <td>
    <input type="text" name="cgen" value="$uenv{'generation'}" size="5" />
    </td></tr>
</table>
END
    }
    my $date_table = &date_setting_table();
        # Print it all out
    $r->print(<<END);
<input type="hidden" name="action" value="enrollstudent" />
<input type="hidden" name="state"  value="done" />
<input type="hidden" name="cuname" value="$username" />
<input type="hidden" name="lcdomain" value="$domain" />
<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>

$user_data_html

<h3>Course Data</h3>

<p>Group/Section: <input type="text" name="csec" size="5" />
<p>
$date_table
</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;
}

# ========================================================= Menu Phase Two Drop
sub print_drop_menu {
    my $r=shift;
    $r->print("<h3>Drop Students</h3>");
    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 ($ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) {
        $ENV{'form.Status'} = 'Active';
    }
    my $status_select = &Apache::lonhtmlcommon::StatusOptions
        ($ENV{'form.Status'},'studentform');
    $r->print(<<END);
<input type="hidden" name="action" value="$ENV{'form.action'}" />
<input type="hidden" name="state"  value="" />
<p>
<font size="+1">Current Class List</font>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
END
    if ($ENV{'form.action'} ne 'modifystudent') {
        $r->print(<<END);
<font size="+1">
<a href="javascript:document.studentform.state.value='csv';document.studentform.submit();">CSV format</a>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="javascript:document.studentform.state.value='excel';document.studentform.submit();">Excel format</a>
</font>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Student Status:
END
    }
    $r->print($status_select."</p>\n");
    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_formatted_classlist {
    my $r=shift;
    my $mode = shift;
    my $cid=$ENV{'request.course.id'};
    my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist();
    if (! defined($classlist)) {
        $r->print("There are no students currently enrolled.\n");
    } else {
        &show_class_list($r,$mode,'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'};
    #
    # Variables for excel output
    my ($excel_workbook, $excel_sheet, $excel_filename,$row);
    #
    my $sortby = $ENV{'form.sortby'};
    if ($sortby !~ /^(username|domain|section|fullname|id)$/) {
        $sortby = 'username';
    }
    # 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);

<input type="hidden" name="sortby" value="$sortby" />
<input type="hidden" name="sname"  value="" />
<input type="hidden" name="sdom"   value="" />
<p>
<table border=2>
<tr><th>
       <a href="javascript:document.studentform.sortby.value='username';document.studentform.submit();">username</a>
    </th><th>
       <a href="javascript:document.studentform.sortby.value='domain';document.studentform.submit();">domain</a>
    </th><th>
       <a href="javascript:document.studentform.sortby.value='id';document.studentform.submit();">ID</a>
    </th><th>
       <a href="javascript:document.studentform.sortby.value='fullname';document.studentform.submit();">student name</a>
    </th><th>
       <a href="javascript:document.studentform.sortby.value='section';document.studentform.submit();">section</a>
    </th>
</tr>
END
    } elsif ($mode eq 'csv') {
        if($statusmode eq 'Expired') {
            $r->print('"Students with expired roles"');
        }
        if ($statusmode eq 'Any') {
            $r->print('"'.join('","',("username","domain","ID","student name",
                                      "section","status")).'"'."\n");
        } else {
            $r->print('"'.join('","',("username","domain","ID","student name",
                                      "section")).'"'."\n");
        }
    } elsif ($mode eq 'excel') {
        # Create the excel spreadsheet
        $excel_filename = '/prtspool/'.
            $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
                time.'_'.rand(1000000000).'.xls';
        $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.
                                                       $excel_filename);
        $excel_workbook->set_tempdir('/home/httpd/perl/tmp');
        $excel_sheet = $excel_workbook->addworksheet('classlist');
        #
        my $description = 'Class List for '.
            $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
        $excel_sheet->write($row++,0,$description);
        #
        $excel_sheet->write($row++,0,["username","domain","ID",
                                      "student name","section","status"]);
    }
    #
    # Sort the students
    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("<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="'.
                          "javascript:document.studentform.sname.value='".
                          $username.
                          "';document.studentform.sdom.value='".$domain.
                          "';document.studentform.state.value='selected".
                          "';document.studentform.submit();".'">'.
                          $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($_);
            }
            if ($statusmode eq 'Any') {
                push @line,&Apache::loncommon::csv_translate($status);
            }
            my $tmp = $";
            $" = '","';
            $r->print("\"@line\"\n");
            $" = $tmp;
        } elsif ($mode eq 'excel') {
            $excel_sheet->write($row++,0,[$username,$domain,$id,
                                          $name,$section,$status]);
        }
    }
    if ($mode eq 'view') {
        $r->print('</table><br>');
    } elsif ($mode eq 'excel') {
        $excel_workbook->close();
        $r->print('<p><a href="'.$excel_filename.'">'.
                  'Your Excel spreadsheet</a> is ready for download.</p>'."\n");
    }
}


#
# 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'};
    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('<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 $date_table = &date_setting_table($starttime,$endtime);
    #
    if (! exists($ENV{'form.Status'}) || 
        $ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) {
        $ENV{'form.Status'} = 'crap';
    }
    # Make sure student is enrolled in course    
    $r->print(<<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" />
<input type="hidden" name="sortby"  value="$sortby" />
<input type="hidden" name="Status"  value="$ENV{'form.Status'}" />

<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>
<input type="checkbox" name="forceid" > 
Disable ID/Student Number Safeguard and Force Change of Conflicting IDs
(only do if you know what you are doing)
</p><p>
<b>Section</b>: <input type="text" name="section" value="$section" size="4"/>
</p>
<p>$date_table</p>
<input type="submit" value="Submit Modifications" />
</body></html>
END
    return;
}

#
# modify a single students section 
#
sub modify_single_student {
    my $r = shift;
    #
    # Remove whitespace from the section
    $ENV{'form.section'} =~ s/\s//g;
    #
    # Do the date defaults first
    my ($starttime,$endtime) = &get_dates_from_form();
    if ($ENV{'form.makedatesdefault'}) {
        $r->print(&make_dates_default($starttime,$endtime));
    }
    # Get the 'sortby' and 'Status' variables so the user goes back to their
    # previous screen
    my $sortby = $ENV{'form.sortby'};
    my $status = $ENV{'form.Status'};
    #
    # We always need this information
    my $slogin     = $ENV{'form.slogin'};
    my $sdom       = $ENV{'form.sdomain'};
    #
    # Get the old data
    my %old=&Apache::lonnet::get('environment',
                                 ['firstname','middlename',
                                  'lastname','generation','id'],
                                 $sdom, $slogin);
    $old{'section'} = &Apache::lonnet::getsection($sdom,$slogin,
                                                  $ENV{'request.course.id'});
    my ($tmp) = keys(%old);
    if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
        $r->print("There was an error determining the environment values ".
                  " 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 $displayable_starttime = localtime($starttime);
    my $displayable_endtime   = localtime($endtime);
    # 
    # check for forceid override
    if ((defined($old{'id'})) && ($old{'id'} ne '') && 
        ($sid ne $old{'id'}) && (! exists($ENV{'form.forceid'}))) {
        $r->print("<font color=\"ff0000\">You changed the students id ".
                  " but did not disable the ID change safeguard.".
                  "  The students id will not be changed.</font>");
        $sid = $old{'id'};
    }
    #
    # talk to the user about what we are going to do
    $r->print(<<END);
    <h2>Modifying data for user $slogin \@ $sdom </h2>
<h3>Student Information</h3>
<table rules="rows" border="1" cellpadding="3" >
<tr>
    <th> Field </th>
    <th> Old Value </th>
    <th> New Value </th>
</tr>
<tr>
    <td> <b>First name</b> </td>
    <td> $old{'firstname'} </td>
    <td> $firstname </td>
</tr><tr>
    <td> <b>Middle name</b> </td>
    <td> $old{'middlename'} </td>
    <td> $middlename </td>
</tr><tr>
    <td> <b>Last name</b> </td>
    <td> $old{'lastname'} </td>
    <td> $lastname </td>
</tr><tr>
    <td> <b>Generation</b> </td>
    <td> $old{'generation'} </td>
    <td> $generation </td>
</tr><tr>
    <td> <b>ID</b> </td>
    <td> $old{'id'} </td>
    <td> $sid </td>
</tr><tr>
    <td> <b>Section</b> </td>
    <td> $old{'section'} </td>
    <td> $section</td>
</tr>
</table>
<h3>Role Information</h3>
<table>
<tr><td align="right"><b>Start Time:</b></td><td> $displayable_starttime </td></tr>
<tr><td align="right"><b>End Time:</b></td><td> $displayable_endtime   </td></tr>
</table>
<p>
END
    #
    # Send request(s) to modify data (final undef is for 'desiredhost',
    # which is a moot point because the student already has an account.
    my $modify_section_results = &modifystudent($sdom,$slogin,
                                                $ENV{'request.course.id'},
                                                $section,undef);
    if ($modify_section_results !~ /^ok/) {
        $r->print("An error occured during the attempt to change the ".
                  "section for this student.<br />");
    }
    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.  <br />".
                  "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. <br />".
                  "The student must log out and log in again to see ".
                  "these changes.");
    }
    $r->print(<<END);
</p><p>
<input type="hidden" name="action" value="modifystudent" />
<input type="hidden" name="sortby" value="$sortby" />
<input type="hidden" name="Status" value="$status" />
<a href="javascript:document.studentform.submit();">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)) {
        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'};
    if (! exists($ENV{'form.sortby'})) {
        &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                                                ['sortby']);
    }
    my $sortby = $ENV{'form.sortby'};
    if ($sortby !~ /^(username|domain|section|fullname|id)$/) {
        $sortby = 'username';
    }
    #
    my $action = "drop";
    $r->print(<<END);
<input type="hidden" name="sortby" value="$sortby" />
<input type="hidden" name="action" value="$action" />
<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">
END

    if ($nosort) {
        $r->print(<<END);
<table border=2>
<tr>
    <th>&nbsp;</th>
    <th>username</th>
    <th>domain</th>
    <th>ID</th>
    <th>student name</th>
    <th>section</th>
</tr>
END

    } else  {
        $r->print(<<END);
<table border=2>
<tr><th>&nbsp;</th>
    <th>
       <a href="/adm/dropadd?action=$action&sortby=username">username</a>
    </th><th>
       <a href="/adm/dropadd?action=$action&sortby=domain">domain</a>
    </th><th>
       <a href="/adm/dropadd?action=$action&sortby=id">ID</a>
    </th><th>
       <a href="/adm/dropadd?action=$action&sortby=fullname">student name</a>
    </th><th>
       <a href="/adm/dropadd?action=$action&sortby=section">section</a>
    </th>
</tr>
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");
<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)"> &nbsp;
<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,$enddate) = &get_dates_from_form();
    if ($ENV{'form.makedatesdefault'}) {
        $r->print(&make_dates_default($startdate,$enddate));
    }
    # Determine domain and desired host (home server)
    my $domain=$ENV{'form.lcdomain'};
    my $desiredhost = $ENV{'form.lcserver'};
    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>'."\n".'<p>');
        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('<br /><b>Unacceptable username: '.
                              $entries{$fields{'username'}}.' for user '.
                              $fname.' '.$mname.' '.$lname.' '.$gen.'</b>');
                } else {
                    # determine section number
                    my $sec='';
                    my $username=$entries{$fields{'username'}};
                    if (defined($fields{'sec'})) {
                        if (defined($entries{$fields{'sec'}})) {
                            $sec=$entries{$fields{'sec'}};
                        }
                    }
                    # remove whitespace from section
                    $sec =~ s/\s//g;
                    # 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 email address
                    my $email='';
                    if (defined($fields{'email'})) {
                        if (defined($entries{$fields{'email'}})) {
                            $email=$entries{$fields{'email'}};
                            unless ($email=~/^[^\@]+\@[^\@]+$/) { $email=''; }
                        }
                    }
                    # 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,
                             $email);
                        if ($reply ne 'ok') {
                            $reply =~ s/^error://;
                            $r->print('<br /><b>'.$username.'</b>:'.
                                      '  Unable to enroll: '.$reply);
         		} else {
                            $count++; $flushc++;
                            $student{$username}=1;
                            $r->print('. ');
                            if ($flushc>15) {
				$r->rflush;
                                $flushc=0;
                            }
                        }
                    } else {
                        $r->print('<br /><b>'.$username.'</b>:'.
                           '  Unable to enroll: No password specified.');
                    }
                }
            }
        } # end of foreach (@studentdata)
        $r->print('</p><p>Processed Students: '.$count.'</p>');
        $r->print("<p>If active, the new role will be available when the ".
                  "students next log in to LON-CAPA.</p>");
        #####################################
        #           Drop students           #
        #####################################
        if ($ENV{'form.fullup'} eq 'yes') {
            $r->print('<h3>Dropping Students</h3>');
            #  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.'<br>');
            $count++;
        } else {
            $r->print('Error dropping '.$uname.' @ '.$udom.': '.$result.
                      '<br />');
        }
    }
    $r->print('<p><b>Dropped '.$count.' student(s).</b>');
    $r->print('<p>Re-enrollment will re-activate data.') if ($count);
}

###################################################################
###################################################################

=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 student username domain form
 enrollstudent    gotusername    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'})) {
            &get_student_username_domain_form($r);
        } elsif ($ENV{'form.state'} eq 'gotusername') {
            &print_enroll_single_student_form($r);
        } elsif ($ENV{'form.state'} eq 'enrolling') {
            &enroll_single_student($r);
        } else {
            &get_student_username_domain_form($r);
        }
    } elsif ($ENV{'form.action'} eq 'classlist') {
        if (! exists($ENV{'form.state'})) {
            &print_html_classlist($r);
        } elsif ($ENV{'form.state'} eq 'csv') {
            &print_formatted_classlist($r,'csv');
        } elsif ($ENV{'form.state'} eq 'excel') {
            &print_formatted_classlist($r,'excel');
        } 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>