[LON-CAPA-cvs] cvs: loncom /interface londropadd.pm
matthew
lon-capa-cvs@mail.lon-capa.org
Tue, 17 Sep 2002 15:52:44 -0000
This is a MIME encoded message
--matthew1032277964
Content-Type: text/plain
matthew Tue Sep 17 11:52:44 2002 EDT
Modified files:
/loncom/interface londropadd.pm
Log:
Highlights:
Now have 'modify student data' options, although you cannot actually modify
any student data yet.
Selecting a students name in the classlist display will take you to their
'aboutme' page.
Gory details:
Many internal changes to state keeping.
The current page displayed is determined by two parameters, 'action' and
'state'.
Changed subroutine names to describe what they do.
Reformatted single student enrollment form.
Added input variable to &show_class_list to determine what sort of link
to place around user names.
Modified &print_html_classlist to take advantage of new &show_class_list
Added &print_modify_student_form, which works wonderfully.
Added &modify_single_student, which tells you what it wants to do but
cannot actually do it.
Added &get_enrollment_data, which will probably be removed soon.
Added &drop_students to do just that.
Modified &handler to implement state keeping changes and document it.
--matthew1032277964
Content-Type: text/plain
Content-Disposition: attachment; filename="matthew-20020917115244.txt"
Index: loncom/interface/londropadd.pm
diff -u loncom/interface/londropadd.pm:1.49 loncom/interface/londropadd.pm:1.50
--- loncom/interface/londropadd.pm:1.49 Fri Sep 13 11:33:39 2002
+++ loncom/interface/londropadd.pm Tue Sep 17 11:52:44 2002
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Handler to drop and add students in courses
#
-# $Id: londropadd.pm,v 1.49 2002/09/13 15:33:39 matthew Exp $
+# $Id: londropadd.pm,v 1.50 2002/09/17 15:52:44 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -31,33 +31,19 @@
#
# (TeX Content Handler
#
-# YEAR=2000
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
-#
-# 10/11,10/12,10/16 Gerd Kortemeyer)
-#
-# 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28,
-# 12/08,12/12 Gerd Kortemeyer)
-#
-# 12/26,12/27,12/28,
-# YEAR=2001
-# 01/01/01,01/15,02/10,02/13,02/14,02/22 Gerd Kortemeyer
-# 8/6 Scott Harrison
-# Guy Albertelli
-# 9/25 Gerd Kortemeyer
-# 12/19 Guy Albertelli
-# YEAR=2002
-# 1/4 Gerd Kortemeyer
+###############################################################
+###############################################################
package Apache::londropadd;
use strict;
use Apache::lonnet();
use Apache::loncommon();
+use Apache::lonhtmlcommon();
use Apache::Constants qw(:common :http REDIRECT);
-# ================================================================ Print header
-
+###############################################################
+###############################################################
sub header {
my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager');
return(<<ENDHEAD);
@@ -71,7 +57,9 @@
ENDHEAD
}
-# =========== Drop student from all sections of a course, except optional $csec
+###############################################################
+###############################################################
+# Drop student from all sections of a course, except optional $csec
sub modifystudent {
my ($udom,$unam,$courseid,$csec,$desiredhost)=@_;
# if $csec is undefined, drop the student from all the courses matching
@@ -93,6 +81,7 @@
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,'','','','','','','',
@@ -110,7 +99,9 @@
return $result;
}
-# ============ build a domain and server selection form
+###############################################################
+###############################################################
+# build a domain and server selection form
sub domain_form {
my ($defdom) = @_;
# Set up domain and server selection forms
@@ -139,29 +130,55 @@
return $result;
}
-# ============================================================== Menu Phase One
-sub menu_phase_one {
+###############################################################
+###############################################################
+# Menu Phase One
+sub print_main_menu {
my $r=shift;
$r->print(<<END);
<p>
-<font size="+1"><a href="/adm/dropadd?phase=two&uplist=yes">Upload a course list</a></font>
+<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?phase=two&enroll=yes">Enroll a single student</a></font>
+<font size="+1">
+ <a href="/adm/dropadd?action=modifystudent">Modify student data</a>
+</font>
</p><p>
-<font size="+1"><a href="/adm/dropadd?phase=two&view=yes">View Classlist</a></font>
+<font size="+1">
+ <a href="/adm/dropadd?action=classlist">View Classlist</a>
+</font>
</p><p>
-<font size="+1"><a href="/adm/dropadd?phase=two&drop=yes">Drop Students</a></font>
+<font size="+1">
+ <a href="/adm/dropadd?action=drop">Drop Students</a>
+</font>
</p>
END
}
-sub phase_two_header {
+###############################################################
+###############################################################
+sub print_upload_manager_header {
my ($r,$datatoken,$distotal,$krbdefdom)=@_;
my $javascript;
+ if (! exists($ENV{'form.upfile_associate'})) {
+ $ENV{'form.upfile_associate'} = 'forward';
+ }
+ if ($ENV{'form.associate'} eq 'Reverse Association') {
+ if ( $ENV{'form.upfile_associate'} ne 'reverse' ) {
+ $ENV{'form.upfile_associate'} = 'reverse';
+ } else {
+ $ENV{'form.upfile_associate'} = 'forward';
+ }
+ }
if ($ENV{'form.upfile_associate'} eq 'reverse') {
- $javascript=&phase_two_javascript_reverse_associate();
+ $javascript=&upload_manager_javascript_reverse_associate();
} else {
- $javascript=&phase_two_javascript_forward_associate();
+ $javascript=&upload_manager_javascript_forward_associate();
}
my $javascript_validations=&javascript_validations($krbdefdom);
$r->print(<<ENDPICK);
@@ -172,8 +189,9 @@
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="phase" value="three" />
<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'}" />
@@ -187,6 +205,8 @@
ENDPICK
}
+###############################################################
+###############################################################
sub javascript_validations {
my ($krbdefdom)=@_;
my %param = ( formname => 'studentform',
@@ -247,10 +267,12 @@
message+='Continue enrollment?';
if (confirm(message)) {
pclose();
+ vf.state.value='enrolling';
vf.submit();
}
} else {
pclose();
+ vf.state.value='enrolling';
vf.submit();
}
}
@@ -288,7 +310,9 @@
}
-sub phase_two_javascript_forward_associate {
+###############################################################
+###############################################################
+sub upload_manager_javascript_forward_associate {
return(<<ENDPICK);
function verify(vf) {
var founduname=0;
@@ -376,7 +400,9 @@
ENDPICK
}
-sub phase_two_javascript_reverse_associate {
+###############################################################
+###############################################################
+sub upload_manager_javascript_reverse_associate {
return(<<ENDPICK);
function verify(vf) {
var founduname=0;
@@ -429,7 +455,9 @@
ENDPICK
}
-sub phase_two_end {
+###############################################################
+###############################################################
+sub print_upload_manager_footer {
my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_;
my %param = ( formname => 'document.studentform');
my $krbform = &Apache::loncommon::authform_kerberos(%param);
@@ -474,12 +502,12 @@
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 might be time consuming.
+Note: for large courses, this operation may be time consuming.
ENDPICK
}
# ======================================================= Menu Phase Two Upload
-sub menu_phase_two_upload {
+sub print_upload_manager_form {
my $r=shift;
my $datatoken;
@@ -498,14 +526,18 @@
my $today=time;
my $halfyear=$today+15552000;
my $defdom=$r->dir_config('lonDefDomain');
- &phase_two_header($r,$datatoken,$distotal,$krbdefdom);
+ &print_upload_manager_header($r,$datatoken,$distotal,$krbdefdom);
my $i;
my $keyfields;
if ($total>=0) {
- my @d=(['username','Username'],['names','Last Name, First Names'],
- ['fname','First Name'],['mname','Middle Names/Initials'],
- ['lname','Last Name'],['gen','Generation'],
- ['id','ID/Student Number'],['sec','Group/Section'],
+ my @d=(['username','Username'],
+ ['names','Last Name, First Names'],
+ ['fname','First Name'],
+ ['mname','Middle Names/Initials'],
+ ['lname','Last Name'],
+ ['gen','Generation'],
+ ['id','ID/Student Number'],
+ ['sec','Group/Section'],
['ipwd','Initial Password']);
if ($ENV{'form.upfile_associate'} eq 'reverse') {
&Apache::loncommon::csv_print_samples($r,\@records);
@@ -519,7 +551,7 @@
$keyfields=join(',',sort(keys(%sone)));
}
}
- &phase_two_end($r,$i,$keyfields,$defdom,$today,$halfyear);
+ &print_upload_manager_footer($r,$i,$keyfields,$defdom,$today,$halfyear);
}
# ======================================================= Enroll single student
@@ -584,7 +616,7 @@
}
# ======================================================= Menu Phase Two Enroll
-sub menu_phase_two_enroll {
+sub print_enroll_single_student_form {
my $r=shift;
$r->print("<h3>Enroll One Student</h3>");
my ($krbdefdom) = $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
@@ -601,7 +633,10 @@
# Set up domain selection form
my $domform = &domain_form($defdom);
# Print it all out
- $r->print(<<ENDSENROLL);
+ $r->print(<<END);
+<input type="hidden" name="action" value="enrollstudent">
+<input type="hidden" name="state" value="done">
+
<script type="text/javascript" language="Javascript">
function verify(vf) {
var founduname=0;
@@ -639,14 +674,12 @@
</script>
<h3>Personal Data</h3>
-First Name: <input type="text" name="cfirst" size="15"><br>
-Middle Name: <input type="text" name="cmiddle" size="15"><br>
-Last Name: <input type="text" name="clast" size="15"><br>
-Generation: <input type="text" name="cgen" size="5">
-
-<p>ID/Student Number: <input type="text" name="cstid" size="10"></p>
-
-<p>Group/Section: <input type=text name=csec size=5></p>
+<table>
+<tr><td>First Name:</td><td> <input type="text" name="cfirst" size="15"></td></tr>
+<tr><td>Middle Name:</td><td> <input type="text" name="cmiddle" size="15"></td></tr>
+<tr><td>Last Name: </td><td><input type="text" name="clast" size="15"></td></tr>
+<tr><td>Generation: </td><td><input type="text" name="cgen" size="5"> </td></tr>
+</table>
<h3>Login Data</h3>
<p>Username: <input type="text" name="cuname" size="15"></p>
@@ -659,12 +692,17 @@
</p><p>
$locform
</p><p>
-<h3>Starting and Ending Dates</h3>
-<input type="hidden" value='' name="pres_value">
-<input type="hidden" value='' name="pres_type">
-<input type="hidden" value='' name="pres_marker">
-<input type="hidden" value='$today' name=startdate>
-<input type="hidden" value='$halfyear' name=enddate>
+
+<h3>Course Data</h3>
+
+<p>Group/Section: <input type="text" name="csec" size="5" />
+<p>
+<!-- Date setting form elements -->
+<input type="hidden" name="pres_value" value='' />
+<input type="hidden" name="pres_type" value='' />
+<input type="hidden" name="pres_marker" value='' />
+<input type="hidden" name="startdate" value='$today' />
+<input type="hidden" name="enddate" value='$halfyear' />
</p><p>
<a
href="javascript:pjump('date_start','Enrollment Starting Date',document.studentform.startdate.value,'start','studentform.pres','dateset');"
@@ -673,15 +711,19 @@
<a
href="javascript:pjump('date_end','Enrollment Ending Date',document.studentform.enddate.value,'end','studentform.pres','dateset');"
>Set Ending Date</a>
-</p><p>
+</p>
<h3>ID/Student Number</h3>
+<p>
+ID/Student Number: <input type="text" name="cstid" size="10">
+</p><p>
<input type="checkbox" name="forceid" value="yes">
Disable ID/Student Number Safeguard and Force Change of Conflicting IDs
-(only do if you know what you are doing)<p>
-<input type="button" onClick="verify(this.form)" value="Enroll as student"><br>
-<input type="hidden" name="phase" value="five">
+(only do if you know what you are doing)
+</p><p>
+<input type="button" onClick="verify(this.form)" value="Enroll as student">
</p>
-ENDSENROLL
+END
+ return;
}
# =================================================== get the current classlist
@@ -731,11 +773,13 @@
}
# ============================================== view classlist
-sub menu_phase_two_view {
+sub print_html_classlist {
my $r=shift;
$r->print(<<END);
+<p>
<font size="+1">Current Classlist</font>
-<font size="+1"><a href="/adm/dropadd?phase=two&viewcsv=yes">CSV format</a></font><br />
+<font size="+1"><a href="/adm/dropadd?action=classlist&state=csv">CSV format</a></font>
+</p>
END
my $cid=$ENV{'request.course.id'};
my ($error,%currentlist)=&get_current_classlist
@@ -750,12 +794,16 @@
$r->print("There are no students currently enrolled.\n");
} else {
# Print out the available choices
- &show_class_list($r,'view',%currentlist);
+ if ($ENV{'form.action'} eq 'modifystudent') {
+ &show_class_list($r,'view','modify',%currentlist);
+ } else {
+ &show_class_list($r,'view','aboutme',%currentlist);
+ }
}
}
# ============================================== view classlist
-sub menu_phase_two_viewcsv {
+sub print_csv_classlist {
my $r=shift;
my $cid=$ENV{'request.course.id'};
my ($error,%currentlist)=&get_current_classlist
@@ -769,16 +817,21 @@
} elsif (!defined(%currentlist)) {
$r->print("There are no students currently enrolled.\n");
} else {
- &show_class_list($r,'csv',%currentlist);
+ &show_class_list($r,'csv','nolink',%currentlist);
}
}
# =================================================== Show student list to drop
sub show_class_list {
- my ($r,$mode,%currentlist)=@_;
+ my ($r,$mode,$linkto,%currentlist)=@_;
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>
@@ -786,9 +839,9 @@
<th>student name</th><th>generation</th><th>section</th></tr>
END
} elsif ($mode eq 'csv') {
- $r->print(<<END);
-username,domain,ID,last name,first name,middle name,generation,section
-END
+ $r->print('"'.join('","',("username","domain","ID","last name",
+ "first name","middle name","generation",
+ "section")).'"'."\n");
}
foreach (sort keys %currentlist) {
my ($sname,$sdom)=split(/\:/,$_);
@@ -800,16 +853,29 @@
$sdom, $sname);
my ($tmp) = keys(%info);
if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
- $r->print( ($mode eq 'view' ?
- '<tr><td colspan="6"><font color="red">' :'').
- 'Internal error: unable to get environment '.
- 'for '.$sname.' in domain '.$sdom.
- ( $mode eq 'view' ?'</font></td></tr>' :''));
+ if ($mode eq 'view') {
+ $r->print('<tr><td colspan="6"><font color="red">'.
+ 'Internal error: unable to get environment '.
+ 'for '.$sname.' in domain '.$sdom.'</font></td></tr>');
+ } else {
+ $r->print('"Internal error: unable to get environment for '.
+ $sname.' in domain '.$sdom.'"');
+ }
} else {
if ($mode eq 'view') {
+ $r->print("<tr>\n <td>\n ");
+ if ($linkto eq 'nothing') {
+ $r->print($sname);
+ } elsif ($linkto eq 'aboutme') {
+ $r->print(&Apache::loncommon::aboutmewrapper($sname,$sname,
+ $sdom));
+ } elsif ($linkto eq 'modify') {
+ $r->print('<a href="/adm/dropadd?action=modifystudent'.
+ '&state=selected'.'&sname='.$sname.
+ '&sdom='.$sdom.'">'.$sname."</a>\n");
+ }
$r->print(<<"END");
-<tr>
- <td>$sname</td>
+ </td>
<td>$sdom</td>
<td>$reply{$sname}</td>
<td>$info{'lastname'}, $info{'firstname'} $info{'middlename'}</td>
@@ -818,6 +884,7 @@
</tr>
END
} elsif ($mode eq 'csv') {
+ # no need to bother with $linkto
my @line = ();
foreach ($sname,$sdom,$reply{$sname},
$info{'lastname'},$info{'firstname'},
@@ -834,11 +901,173 @@
$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'],
+ $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);
+<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>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 $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);
+Modifying data for user: $sname \@ $sdom <br />
+<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>
+END
+ # send request(s) to modify data
+ my $roleresults = 'refused';
+ #my $roleresults = &Apache::lonnet::assignrole($sdom,$sname,
+ # $courseid.'/'.$section,
+ # 'st',
+ # $endtime,$starttime);
+ if ($roleresults =~/refused/) {
+ $r->print("Your request to change the role information for this ".
+ "student was refused.");
+ } elsif ($roleresults !~ /ok/) {
+ $r->print("An error occurred during the attempt to change the role".
+ " information for this student. The error reported was ".
+ $roleresults);
+ } else { # everything is okay!
+ $r->print("Student role updated successfully.");
+ }
+ #
+ $r->print(<<END);
+</body></html>
+END
+ return;
+}
+
+sub get_enrollment_data {
+ my ($sname,$sdomain) = @_;
+ my $courseid = $ENV{'request.course.id'};
+ $courseid =~ s:_:/:g;
+ my %roles = &Apache::lonnet::dump('roles',$sdomain,$sname);
+ my ($tmp) = keys(%roles);
+ # Bail out if we were unable to get the students roles
+ return "666" if ($tmp =~ /^(con_lost|error|no_such_host)/i);
+ # Go through the roles looking for enrollment in this course
+ my ($end,$start) = (undef,undef);
+ my $section = '';
+ my $count = scalar(keys(%roles));
+ while (my ($course,$role) = each(%roles)) {
+ &Apache::lonnet::logthis('course = '.$course.' role = '.$role);
+ if ($course=~ /^\/$courseid\/*\s*(\w+)*_st$/ ) {
+ #
+ # Get active role
+ $section=$1;
+ (undef,$end,$start)=split(/\_/,$role);
+ my $now=time;
+ my $notactive=0;
+ if ($start) {
+ if ($now<$start) { $notactive=1; }
+ }
+ if ($end) {
+ if ($now>$end) { $notactive=1; }
+ }
+ unless ($notactive) { return ($start,$end,$section); }
+ }
+ }
+ return ($start,$end,$section);
+}
+
# =================================================== Show student list to drop
sub show_drop_list {
my ($r,%currentlist)=@_;
my $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)
{
@@ -909,11 +1138,13 @@
"How do I create a CSV file from a spreadsheet");
$r->print(<<ENDUPFORM);
<input type=hidden name=phase value=two>
-<hr>
<h3>Upload a courselist</h3>
$upfile_select
-<p><input type=submit name="fileupload" value="Upload Courselist">
-<br />
+<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>
@@ -1096,6 +1327,43 @@
} # 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;
@@ -1121,7 +1389,39 @@
$r->print('<p>Re-enrollment will re-activate data.');
}
-# ================================================================ Main Handler
+###################################################################
+###################################################################
+
+=pod
+
+=item &handler
+
+The typical handler you see in all these modules. Takes $r, the
+http request, as an argument.
+
+The response to the request is governed by two form variables
+
+ form.action form.state response
+ ---------------------------------------------------
+ undefined undefined print main menu
+ upload undefined print courselist upload menu
+ upload got_file deal with uploaded file,
+ print the upload managing menu
+ upload enrolling enroll students based on upload
+ drop undefined print the classlist ready to drop
+ drop done drop the selected students
+ enrollstudent undefined print single student enroll menu
+ enrollstudent enrolling enroll student
+ classlist undefined print html classlist
+ classlist csv print csv classlist
+ modifystudent undefined print classlist to select student to modify
+ modifystudent selected print modify student menu
+ modifystudent done make modifications to student record
+
+=cut
+
+###################################################################
+###################################################################
sub handler {
my $r=shift;
if ($r->header_only) {
@@ -1130,68 +1430,99 @@
return OK;
}
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- ['enroll','drop','view','phase',
- 'viewcsv','uplist']);
+ ['action','state']);
# Needs to be in a course
- if (($ENV{'request.course.fn'}) &&
- (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'}))) {
+ if (! (($ENV{'request.course.fn'}) &&
+ (&Apache::lonnet::allowed('cst',$ENV{'request.course.id'})))) {
+ # Not in a course, or not allowed to modify parms
+ $ENV{'user.error.msg'}=
+ "/adm/dropadd:cst:0:0:Cannot drop or add students";
+ return HTTP_NOT_ACCEPTABLE;
+ }
+ #
+ # Only output the header information if they did not request csv format
+ #
+ if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) {
+ $r->content_type('text/csv');
+ } else {
# Start page
- $r->content_type('text/html') if (! exists($ENV{'form.viewcsv'}));
+ $r->content_type('text/html');
$r->send_http_header;
- $r->print(&header()) if (! exists($ENV{'form.viewcsv'}));
- # Phase one, initial screen
- unless ($ENV{'form.phase'}) {
- &menu_phase_one($r);
- }
- # Phase two
- if ($ENV{'form.associate'} eq 'Reverse Association') {
- $ENV{'form.phase'} = 'two';
- if ( $ENV{'form.upfile_associate'} ne 'reverse' ) {
- $ENV{'form.upfile_associate'} = 'reverse';
- } else {
- $ENV{'form.upfile_associate'} = 'forward';
- }
- }
- if ($ENV{'form.phase'} eq 'two') {
- if ($ENV{'form.uplist'}) {
- &print_first_courselist_upload_form($r);
- } elsif ($ENV{'form.fileupload'}) {
- &menu_phase_two_upload($r);
- } elsif ($ENV{'form.enroll'}) {
- &menu_phase_two_enroll($r);
- } elsif ($ENV{'form.drop'}) {
- &menu_phase_two_drop($r);
- } elsif ($ENV{'form.view'}) {
- &menu_phase_two_view($r);
- } elsif ($ENV{'form.viewcsv'}) {
- &menu_phase_two_viewcsv($r);
- }
- }
- # Phase three
- if ($ENV{'form.phase'} eq 'three') {
+ $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);
}
- # Phase four
- if ($ENV{'form.phase'} eq 'four') {
+ } elsif ($ENV{'form.action'} eq 'drop') {
+ if (! exists($ENV{'form.state'})) {
+ &menu_phase_two_drop($r);
+ } elsif ($ENV{'form.state'} eq 'done') {
&drop_student_list($r);
+ } else {
+ &menu_phase_two_drop($r);
}
- # Phase five
- if ($ENV{'form.phase'} eq 'five') {
+ } elsif ($ENV{'form.action'} eq 'enrollstudent') {
+ if (! exists($ENV{'form.state'})) {
+ &print_enroll_single_student_form($r);
+ } elsif ($ENV{'form.state'} eq 'enrolling') {
&enroll_single_student($r);
+ } else {
+ &print_enroll_single_student_form($r);
}
- # End
- $r->print('</form></body></html>') if (! exists($ENV{'form.viewcsv'}));
+ } elsif ($ENV{'form.action'} eq 'classlist') {
+ if (! exists($ENV{'form.state'})) {
+ &print_html_classlist($r);
+ } elsif ($ENV{'form.state'} eq 'csv') {
+ &print_csv_classlist($r);
+ } else {
+ &print_html_classlist($r);
+ }
+ } elsif ($ENV{'form.action'} eq 'modifystudent') {
+ if (! exists($ENV{'form.state'})) {
+ &print_html_classlist($r);
+ } elsif ($ENV{'form.state'} eq 'selected') {
+ &print_modify_student_form($r);
+ } elsif ($ENV{'form.state'} eq 'done') {
+ &modify_single_student($r);
+ } else {
+ &print_html_classlist($r);
+ }
} else {
- # Not in a course, or not allowed to modify parms
- $ENV{'user.error.msg'}=
- "/adm/dropadd:cst:0:0:Cannot drop or add students";
- return HTTP_NOT_ACCEPTABLE;
+ # We should not end up here, but I guess it is possible
+ &Apache::lonnet::logthis("Undetermined state in londropadd.pm. ".
+ "form.action = ".$ENV{'form.action'}.
+ "Someone should fix this.");
+ &print_main_menu($r);
+ }
+ #
+ # Finish up
+ if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) {
+ $r->print("\n");
+ } else {
+ $r->print('</form></body></html>');
}
return OK;
}
+###################################################################
+###################################################################
+
1;
__END__
+
--matthew1032277964--