--- loncom/interface/Attic/londropadd.pm 2002/09/17 15:52:44 1.50 +++ loncom/interface/Attic/londropadd.pm 2002/10/16 13:00:57 1.57 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to drop and add students in courses # -# $Id: londropadd.pm,v 1.50 2002/09/17 15:52:44 matthew Exp $ +# $Id: londropadd.pm,v 1.57 2002/10/16 13:00:57 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -558,7 +558,7 @@ sub print_upload_manager_form { sub enroll_single_student { my $r=shift; $r->print('

Enrolling Student

'); - $r->print('

Enrolling '.$ENV{'form.cuname'}." in domain ". + $r->print('

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

'); if (($ENV{'form.cuname'})&&($ENV{'form.cuname'}!~/\W/)&& ($ENV{'form.lcdomain'})&&($ENV{'form.lcdomain'}!~/\W/)) { @@ -594,17 +594,25 @@ sub enroll_single_student { 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); - $r->print(&Apache::lonnet::modifystudent( - $ENV{'form.lcdomain'},$ENV{'form.cuname'}, - $ENV{'form.cstid'},$amode,$genpwd, - $ENV{'form.cfirst'},$ENV{'form.cmiddle'}, - $ENV{'form.clast'},$ENV{'form.cgen'}, - $ENV{'form.csec'},$ENV{'form.enddate'}, - $ENV{'form.startdate'},$ENV{'form.forceid'}, - $desiredhost)); + my $login_result = &Apache::lonnet::modifystudent + ($ENV{'form.lcdomain'},$ENV{'form.cuname'}, + $ENV{'form.cstid'},$amode,$genpwd, + $ENV{'form.cfirst'},$ENV{'form.cmiddle'}, + $ENV{'form.clast'},$ENV{'form.cgen'}, + $ENV{'form.csec'},$ENV{'form.enddate'}, + $ENV{'form.startdate'},$ENV{'form.forceid'}, + $desiredhost); + if ($login_result =~ /^ok/) { + $r->print($login_result); + $r->print("

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

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

ERROR '. 'Invalid login mode or password. '. @@ -726,78 +734,58 @@ END return; } -# =================================================== get the current classlist -sub get_current_classlist { - my ($domain,$identifier) = @_; - # domain is the domain the class is being run in - # identifier is the internal, unique identifier for the class. - my %currentlist=(); - my $now=time; - my %results=&Apache::lonnet::dump('classlist',$domain,$identifier); - my ($tmp) = keys(%results); - if ($tmp !~ /^(con_lost|error|no_such_host)/i) { - foreach my $student (keys(%results)) { - # Extract the start and end dates - my ($end,$start)=split(/\:/,$results{$student}); - # If the class isn't over, put it in the list - unless (($end) && ($now>$end)) { - $currentlist{$student}=1; - } - } - return (undef,%currentlist); - } else { - $tmp =~ s/^error://; - return ($tmp,undef); - } -} - # ========================================================= Menu Phase Two Drop -sub menu_phase_two_drop { +sub print_drop_menu { my $r=shift; $r->print("

Drop Students

"); my $cid=$ENV{'request.course.id'}; - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'},$ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - if ($error =~ /^No such file or directory/) { - $r->print("There are no students currently enrolled.\n"); - } else { - $r->print("
ERROR:$error
"); - } - } elsif (!defined(%currentlist)) { + 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 - &show_drop_list($r,%currentlist); + return; } + # Print out the available choices + &show_drop_list($r,$classlist,$keylist); + return; } # ============================================== view classlist sub print_html_classlist { my $r=shift; + if (! exists($ENV{'form.sortby'})) { + $ENV{'form.sortby'} = 'username'; + } + if (! exists($ENV{'form.Status'}) || + $ENV{'form.Status'} !~ /^(Any|Expired|Active)$/) { + $ENV{'form.Status'} = 'Active'; + } + my $status_select = &Apache::lonhtmlcommon::StatusOptions + ($ENV{'form.Status'},'studentform'); $r->print(< +

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

END my $cid=$ENV{'request.course.id'}; - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'},$ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - if ($error =~ /^No such file or directory/) { - $r->print("There are no students currently enrolled.\n"); - } else { - $r->print("
ERROR:$error
"); - } - } elsif (!defined(%currentlist)) { + 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',%currentlist); + &show_class_list($r,'view','modify','modifystudent', + $ENV{'form.Status'},$classlist,$keylist); } else { - &show_class_list($r,'view','aboutme',%currentlist); + &show_class_list($r,'view','aboutme','classlist', + $ENV{'form.Status'},$classlist,$keylist); } } } @@ -806,96 +794,110 @@ END sub print_csv_classlist { my $r=shift; my $cid=$ENV{'request.course.id'}; - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'},$ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - if ($error =~ /^No such file or directory/) { - $r->print("There are no students currently enrolled.\n"); - } else { - $r->print("
ERROR:$error
"); - } - } elsif (!defined(%currentlist)) { + my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist(); + if (! defined($classlist)) { $r->print("There are no students currently enrolled.\n"); } else { - &show_class_list($r,'csv','nolink',%currentlist); + &show_class_list($r,'csv','nolink','csv', + $ENV{'form.Status'},$classlist,$keylist); } } # =================================================== Show student list to drop sub show_class_list { - my ($r,$mode,$linkto,%currentlist)=@_; + my ($r,$mode,$linkto,$action,$statusmode,$classlist,$keylist)=@_; my $cid=$ENV{'request.course.id'}; +# &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, +# ['sortby']); + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id)$/) { + $sortby = 'username'; + } # Print out header if ($mode eq 'view') { if ($linkto eq 'aboutme') { - $r->print('Select a user name to view the users page.'); + $r->print('Select a user name to view the users personal page.'); } elsif ($linkto eq 'modify') { $r->print('Select a user name to modify the students information'); } $r->print(<

- - + + END } elsif ($mode eq 'csv') { - $r->print('"'.join('","',("username","domain","ID","last name", - "first name","middle name","generation", + $r->print('"'.join('","',("username","domain","ID","student name", "section")).'"'."\n"); } - foreach (sort keys %currentlist) { - my ($sname,$sdom)=split(/\:/,$_); - my %reply=&Apache::lonnet::idrget($sdom,$sname); - my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid); - my %info=&Apache::lonnet::get('environment', - ['firstname','middlename', - 'lastname','generation'], - $sdom, $sname); - my ($tmp) = keys(%info); - if ($tmp =~ /^(con_lost|error|no_such_host)/i) { - if ($mode eq 'view') { - $r->print(''); - } else { - $r->print('"Internal error: unable to get environment for '. - $sname.' in domain '.$sdom.'"'); + # + # Sort the students + my %index; + my $i; + foreach (@$keylist) { + $index{$_} = $i++; + } + my $index = $index{$sortby}; + my $second = $index{'username'}; + my $third = $index{'domain'}; + my @Sorted_Students = sort { + lc($classlist->{$a}->[$index]) cmp lc($classlist->{$b}->[$index]) + || + lc($classlist->{$a}->[$second]) cmp lc($classlist->{$b}->[$second]) + || + lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third]) + } (keys(%$classlist)); + foreach my $student (@Sorted_Students) { + my $username = $classlist->{$student}->[$index{'username'}]; + my $domain = $classlist->{$student}->[$index{'domain'}]; + my $section = $classlist->{$student}->[$index{'section'}]; + my $name = $classlist->{$student}->[$index{'fullname'}]; + my $id = $classlist->{$student}->[$index{'id'}]; + my $status = $classlist->{$student}->[$index{'status'}]; + next if (($statusmode ne 'Any') && ($status ne $statusmode)); + if ($mode eq 'view') { + $r->print("\n \n - - - - - + + + + END - } elsif ($mode eq 'csv') { - # no need to bother with $linkto - my @line = (); - foreach ($sname,$sdom,$reply{$sname}, - $info{'lastname'},$info{'firstname'}, - $info{'middlename'},$info{'generation'},$ssec) { - push @line,&Apache::loncommon::csv_translate($_); - } - my $tmp = $"; - $" = '","'; - $r->print("\"@line\"\n"); - $" = $tmp; + } elsif ($mode eq 'csv') { + # no need to bother with $linkto + my @line = (); + foreach ($username,$domain,$id,$name,$section) { + push @line,&Apache::loncommon::csv_translate($_); } + my $tmp = $"; + $" = '","'; + $r->print("\"@line\"\n"); + $" = $tmp; } } $r->print('
usernamedomainIDstudent namegenerationsection
+ username + + domain + + ID + + student name + + section +
'. - 'Internal error: unable to get environment '. - 'for '.$sname.' in domain '.$sdom.'
\n "); + if ($linkto eq 'nothing') { + $r->print($username); + } elsif ($linkto eq 'aboutme') { + $r->print(&Apache::loncommon::aboutmewrapper($username, + $username, + $domain)); + } elsif ($linkto eq 'modify') { + $r->print(''. + $username."\n"); } - } else { - if ($mode eq 'view') { - $r->print("
\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(''.$sname."\n"); - } - $r->print(<<"END"); + $r->print(<<"END"); $sdom$reply{$sname}$info{'lastname'}, $info{'firstname'} $info{'middlename'}$info{'generation'}$ssec$domain$id$name$section

') if ($mode eq 'view'); @@ -908,14 +910,14 @@ END 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'}; + ['sdom','sname','sortby']); + my $sname = $ENV{'form.sname'}; + my $sdom = $ENV{'form.sdom'}; + my $sortby = $ENV{'form.sortby'}; # determine the students name information my %info=&Apache::lonnet::get('environment', ['firstname','middlename', - 'lastname','generation'], + 'lastname','generation','id'], $sdom, $sname); my ($tmp) = keys(%info); if ($tmp =~ /^(con_lost|error|no_such_host)/i) { @@ -938,10 +940,16 @@ sub print_modify_student_form { $endtime); # Make sure student is enrolled in course $r->print(< + +Only domain coordinators can change a users password. + +

- + +

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

@@ -955,6 +963,12 @@ $info{'lastname'} $info{'generation'}, $

+Student ID: +

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

Section:

@@ -973,30 +987,80 @@ END # sub modify_single_student { my $r = shift; - # make sure user can modify student data? + # Get the 'sortby' variable so the user does not need to re-sort + my $sortby = $ENV{'form.sortby'}; + # + # We always need this information + my $slogin = $ENV{'form.slogin'}; + my $sdom = $ENV{'form.sdomain'}; + # + # Get the old data + my %old=&Apache::lonnet::get('environment', + ['firstname','middlename', + 'lastname','generation','id'], + $sdom, $slogin); + my ($tmp) = keys(%old); + if ($tmp =~ /^(con_lost|error|no_such_host)/i) { + $r->print("There was an error determining the environment values ". + " for $slogin \@ $sdom."); + return; + } + undef $tmp; + # + # Get the new data my $firstname = $ENV{'form.firstname'}; my $middlename = $ENV{'form.middlename'}; my $lastname = $ENV{'form.lastname'}; my $generation = $ENV{'form.generation'}; my $section = $ENV{'form.section'}; my $courseid = $ENV{'request.course.id'}; - my $sname = $ENV{'form.slogin'}; - my $sdom = $ENV{'form.sdomain'}; + my $sid = $ENV{'form.id'}; my $starttime = &Apache::lonhtmlcommon::get_date_from_form('startdate', time); my $endtime = &Apache::lonhtmlcommon::get_date_from_form('enddate', time); my $displayable_starttime = localtime($starttime); my $displayable_endtime = localtime($endtime); + # + # check for forceid override + if (($sid ne $old{'id'}) && (! exists($ENV{'form.forceid'}))) { + $r->print("You changed the students id ". + " but did not disable the ID change safeguard.". + " The students id will not be changed."); + $sid = $old{'id'}; + } + # # talk to the user about what we are going to do $r->print(< +

Modifying data for user $slogin \@ $sdom

Student Information

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

Role Information

@@ -1004,25 +1068,34 @@ Modifying data for user: $sname \@ $sdom
Start Time $displayable_starttime
End Time $displayable_endtime
+

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

+Modify another students data END return; @@ -1061,59 +1134,131 @@ sub get_enrollment_data { return ($start,$end,$section); } -# =================================================== Show student list to drop +################################################# +################################################# + +=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,%currentlist)=@_; + my ($r,$classlist,$keylist,$nosort)=@_; my $cid=$ENV{'request.course.id'}; - $r->print(<<'END'); - + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sortby']); + my $sortby = $ENV{'form.sortby'}; + if ($sortby !~ /^(username|domain|section|fullname|id)$/) { + $sortby = 'username'; + } + # + my $action = "drop"; + $r->print(< +

+END + + if ($nosort) { + $r->print(< - usernamedomain -IDstudent namegeneration -section + +   + username + domain + ID + student name + section + END - foreach (sort keys %currentlist) { - my ($sname,$sdom)=split(/\:/,$_); - my %reply=&Apache::lonnet::idrget($sdom,$sname); - my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid); - my %info=&Apache::lonnet::get('environment', - ['firstname','middlename', - 'lastname','generation'], - $sdom, $sname); - my ($tmp) = keys(%info); - if ($tmp =~ /^(con_lost|error|no_such_host)/i) { - $r->print(''. - 'Internal error: unable to get environment '. - 'for '.$sname.' in domain '.$sdom.''); - } else { - $r->print(<<"END"); + + } else { + $r->print(< +  + + username + + domain + + ID + + student name + + section + + +END + } + # + # Sort the students + my %index; + my $i; + foreach (@$keylist) { + $index{$_} = $i++; + } + my $index = $index{$sortby}; + my $second = $index{'username'}; + my $third = $index{'domain'}; + my @Sorted_Students = sort { + lc($classlist->{$a}->[$index]) cmp lc($classlist->{$b}->[$index]) + || + lc($classlist->{$a}->[$second]) cmp lc($classlist->{$b}->[$second]) + || + lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third]) + } (keys(%$classlist)); + foreach my $student (@Sorted_Students) { + my $error; + my $username = $classlist->{$student}->[$index{'username'}]; + my $domain = $classlist->{$student}->[$index{'domain'}]; + my $section = $classlist->{$student}->[$index{'section'}]; + my $name = $classlist->{$student}->[$index{'fullname'}]; + my $id = $classlist->{$student}->[$index{'id'}]; + my $status = $classlist->{$student}->[$index{'status'}]; + next if ($status ne 'Active'); + # + $r->print(<<"END"); - - $sname - $sdom - $reply{$sname} - $info{'lastname'}, $info{'firstname'} $info{'middlename'} - $info{'generation'} - $ssec + + $username + $domain + $id + $name + $section END - } } $r->print('
'); $r->print(<<"END"); @@ -1122,6 +1267,7 @@ END

END + return; } # @@ -1269,6 +1415,11 @@ sub upfile_drop_add { } } } + # Clean up whitespace + foreach (\$domain,\$username,\$id,\$fname,\$mname, + \$lname,\$gen,\$sec) { + $$_ =~ s/(\s+$|^\s+)//g; + } if ($password) { &modifystudent($domain,$username,$cid,$sec, $desiredhost); @@ -1295,75 +1446,35 @@ sub upfile_drop_add { } } } # end of foreach (@studentdata) - $r->print('

Processed Students: '.$count); + $r->print('

Processed Students: '.$count.'

'); + $r->print("

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

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

Dropping Students

'); # Get current classlist - my ($error,%currentlist)=&get_current_classlist - ($ENV{'course.'.$cid.'.domain'}, - $ENV{'course.'.$cid.'.num'}); - if (defined($error)) { - $r->print('
ERROR:$error
'); - } - if (defined(%currentlist)) { - # Drop the students + 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($currentlist{$entries{$fields{'username'}}. + delete($classlist->{$entries{$fields{'username'}}. ':'.$domain}); } } - # Print out list of dropped students - &show_drop_list($r,%currentlist); - } else { - $r->print("There are no students currently enrolled.\n"); + # Print out list of dropped students. + &show_drop_list($r,$classlist,$keylist,'nosort'); } } } # 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; @@ -1376,11 +1487,12 @@ sub drop_student_list { } 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.' at '.$udom.'
'); + $r->print('Dropped '.$uname.' @ '.$udom.'
'); } else { - $r->print('Error dropping '.$uname.' at '.$udom.': '.$result. + $r->print('Error dropping '.$uname.' @ '.$udom.': '.$result. '
'); } $count++; @@ -1470,11 +1582,11 @@ sub handler { } } elsif ($ENV{'form.action'} eq 'drop') { if (! exists($ENV{'form.state'})) { - &menu_phase_two_drop($r); + &print_drop_menu($r); } elsif ($ENV{'form.state'} eq 'done') { &drop_student_list($r); } else { - &menu_phase_two_drop($r); + &print_drop_menu($r); } } elsif ($ENV{'form.action'} eq 'enrollstudent') { if (! exists($ENV{'form.state'})) {