--- loncom/interface/Attic/londropadd.pm	2007/09/27 18:58:52	1.170
+++ loncom/interface/Attic/londropadd.pm	2012/04/24 21:05:15	1.179
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Handler to drop and add students in courses 
 #
-# $Id: londropadd.pm,v 1.170 2007/09/27 18:58:52 www Exp $
+# $Id: londropadd.pm,v 1.179 2012/04/24 21:05:15 droeschl Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,8 +26,23 @@
 # http://www.lon-capa.org/
 #
 #
-###############################################################
-##############################################################
+
+=head1 NAME
+
+Apache::londropadd.pm
+
+=head1 SYNOPSIS
+
+drop & add students
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=cut
 
 package Apache::londropadd;
 
@@ -42,8 +57,6 @@ use Apache::lonlocal;
 use Apache::longroup;
 use LONCAPA();
 
-###############################################################
-###############################################################
 sub header {
     my ($jscript,$loaditems) = @_;
     my $start_page;
@@ -59,54 +72,14 @@ $start_page
 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
-    my $cdom = $env{'course.'.$courseid.'.domain'};
-    my $cnum = $env{'course.'.$courseid.'.num'};
-    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=~m{^/\Q$cdom\E/\Q$cnum\E(?:\/)*(?:\s+)*(\w+)*\_st$}) {
-            # We are in this course
-            my $section=$1;
-            $section='' if ($course eq "/$cdom/$cnum".'_st');
-            if (defined($csec) && $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;
-}
+=pod
+
+=item domain_form()
+    
+    build a domain and server selection form
+
+=cut
 
-###############################################################
-###############################################################
-# build a domain and server selection form
 sub domain_form {
     my ($defdom) = @_;
     # Set up domain and server selection forms
@@ -135,9 +108,14 @@ sub domain_form {
     return $result;
 }
 
-###############################################################
-###############################################################
-#  Menu Phase One
+=pod
+
+=item print_main_menu()
+
+    Menu Phase One
+
+=cut
+
 sub print_main_menu {
     my ($r,$permission)=@_;
     #
@@ -224,13 +202,15 @@ sub print_main_menu {
     return;
 }
 
-###############################################################
-###############################################################
+
+
 sub hidden_input {
     my ($name,$value) = @_;
     return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'."\n";
 }
 
+
+
 sub print_upload_manager_header {
     my ($r,$datatoken,$distotal,$krbdefdom)=@_;
     my $javascript;
@@ -262,8 +242,9 @@ sub print_upload_manager_header {
         $password_choice = 'int';        
     }
     #
-    my $javascript_validations=&javascript_validations('auth',$krbdefdom,
-                                    $password_choice);
+    my $javascript_validations = 
+        &javascript_validations('auth',$krbdefdom,$password_choice,undef,
+                                $env{'request.role.domain'});
     my $checked=(($env{'form.noFirstLine'})?' checked="checked" ':'');
     $r->print('<h3>'.&mt('Uploading Class List')."</h3>\n".
               "<hr>\n".
@@ -290,10 +271,12 @@ sub print_upload_manager_header {
               $javascript."\n".$javascript_validations.'</script>');
 }
 
-###############################################################
-###############################################################
+
+
+
+
 sub javascript_validations {
-    my ($mode,$krbdefdom,$curr_authtype,$curr_authfield)=@_;
+    my ($mode,$krbdefdom,$curr_authtype,$curr_authfield,$domain)=@_;
     my $authheader;
     if ($mode eq 'auth') {
         my %param = ( formname => 'studentform',
@@ -302,7 +285,7 @@ sub javascript_validations {
         $authheader = &Apache::loncommon::authform_header(%param);
     } elsif ($mode eq 'createcourse') {
         my %param = ( formname => 'ccrs',
-                  kerb_def_dom => $krbdefdom,
+                      kerb_def_dom => $krbdefdom,
                       curr_authtype => $curr_authtype );
         $authheader = &Apache::loncommon::authform_header(%param);
     } elsif ($mode eq 'modifycourse') {
@@ -323,7 +306,7 @@ sub javascript_validations {
          name     => 'The optional name field was not specified.',
          snum     => 'The optional student number field was not specified.',
          section  => 'The optional section field was not specified.', 
-         email    => 'The optional email address field was not specified.',
+         email    => 'The optional e-mail address field was not specified.',
          continue => 'Continue enrollment?',
          );
     
@@ -331,6 +314,7 @@ sub javascript_validations {
     my $function_name =(<<END);
 function verify_message (vf,founduname,foundpwd,foundname,foundid,foundsec,foundemail) {
 END
+    my ($authnum,%can_assign) =  &Apache::loncommon::get_assignable_auth($domain);
     my $auth_checks;
     if ($mode eq 'createcourse') {
         $auth_checks .= (<<END);
@@ -345,9 +329,13 @@ END
         $auth_checks .= (<<END);
     var foundatype=0;
     if (founduname==0) {
-	alert('$alert{'username'}');
+        alert('$alert{'username'}');
         return;
     }
+
+END
+        if ($authnum > 1) {
+            $auth_checks .= (<<END);
     // alert('current.radiovalue = '+current.radiovalue);
     if (current.radiovalue == null || current.radiovalue == '' || current.radiovalue == 'nochange') {
         // They did not check any of the login radiobuttons.
@@ -355,6 +343,7 @@ END
         return;
     }
 END
+        }
     }
     if ($mode eq 'createcourse') {
         $auth_checks .= "
@@ -416,7 +405,7 @@ END
 }
 END
     } else {
-        $section_checks = &section_check_js();
+        $section_checks = &Apache::lonuserutils::section_check_js();
         $optional_checks = (<<END);
     var message='';
     if (foundname==0) { 
@@ -464,8 +453,9 @@ END
     return $result;
 }
 
-###############################################################
-###############################################################
+
+
+
 sub upload_manager_javascript_forward_associate {
     return(<<ENDPICK);
 function verify(vf,sec_caller) {
@@ -557,8 +547,9 @@ function clearpwd(vf) {
 ENDPICK
 }
 
-###############################################################
-###############################################################
+
+
+
 sub upload_manager_javascript_reverse_associate {
     return(<<ENDPICK);
 function verify(vf,sec_caller) {
@@ -612,8 +603,9 @@ function clearpwd(vf) {
 ENDPICK
 }
 
-###############################################################
-###############################################################
+
+
+
 sub print_upload_manager_footer {
     my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_;
 
@@ -666,8 +658,9 @@ sub print_upload_manager_footer {
     return;
 }
 
-###############################################################
-###############################################################
+
+
+
 sub print_upload_manager_form {
     my $r=shift;
 
@@ -721,7 +714,7 @@ sub print_upload_manager_form {
              ['id',   &mt('ID/Student Number'),$env{'form.id_choice'}],
              ['sec',  &mt('Section'),          $env{'form.sec_choice'}],
              ['ipwd', &mt('Initial Password'),$env{'form.ipwd_choice'}],
-             ['email',&mt('EMail Address'),   $env{'form.email_choice'}]);
+             ['email',&mt('E-mail Address'),   $env{'form.email_choice'}]);
 	if ($env{'form.upfile_associate'} eq 'reverse') {	
 	    &Apache::loncommon::csv_print_samples($r,\@records);
 	    $i=&Apache::loncommon::csv_print_select_table($r,\@records,
@@ -741,8 +734,10 @@ sub print_upload_manager_form {
     &print_upload_manager_footer($r,$i,$keyfields,$defdom,$today,$halfyear);
 }
 
-###############################################################
-###############################################################
+
+
+
+
 sub enroll_single_student {
     my ($r,$srcharray) = @_; 
     # Remove non alphanumeric values from section
@@ -752,9 +747,10 @@ sub enroll_single_student {
     # in the course is entirely separate 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();
+    my ($startdate,$enddate) = &Apache::lonuserutils::get_dates_from_form();
     if ($env{'form.makedatesdefault'}) {
-        $r->print(&make_dates_default($startdate,$enddate));
+        $r->print(&Apache::lonuserutils::make_dates_default($startdate,
+                                                            $enddate));
     }
 
     $r->print('<h3>'.&mt('Enrolling Student').'</h3>');
@@ -799,7 +795,7 @@ sub enroll_single_student {
                                                    $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'},
+            &Apache::lonuserutils::modifystudent($env{'form.lcdomain'},$env{'form.cuname'},
                            $env{'request.course.id'},$env{'form.csec'},
                             $desiredhost);
             my $login_result = &Apache::lonnet::modifystudent
@@ -953,9 +949,14 @@ sub make_dates_default {
     return $result;
 }
 
-##
-## Single student enrollment routines (some of them)
-##
+=pod
+
+=item get_student_username_domain_form()
+    
+    Single student enrollment routines (some of them)
+
+=cut
+
 sub get_student_username_domain_form {
     my ($r,$elements,$response,$srch,$forcenewuser) =  @_;
     my $loaditems = {
@@ -1058,7 +1059,9 @@ sub print_enroll_single_student_form {
         # Set up authentication forms
         my ($krbdef,$krbdefdom) =
             &Apache::loncommon::get_kerberos_defaults($ccdomain);
-        $javascript_validations=&javascript_validations('auth',$krbdefdom);
+        $javascript_validations = 
+            &Apache::lonuserutils::javascript_validations('auth',$krbdefdom,
+                                                      undef,undef,$ccdomain);
         my %param = ( formname => 'document.studentform',
                       kerb_def_dom => $krbdefdom,
                       kerb_def_auth => $krbdef
@@ -1080,15 +1083,15 @@ sub print_enroll_single_student_form {
         #
         #
 	my %lt=&Apache::lonlocal::texthash(
-		       'udf'  => "User Data for",
+		       'udf'  => "Personal Data",
                        'fn'   => "First Name",
                        'mn'   => "Middle Name",
                        'ln'   => "Last Name",
                        'gen'  => "Generation",
                        'hs'   => "Home Server",
-                       'pswd' => "Password",
+                       'pswd' => "Login Data",
 		       'psam' => "Please select an authentication mechanism",
-                       'mail' => "Email Address"
+                       'mail' => "E-mail Address"
 					   );
 	my $authhelp=&Apache::loncommon::help_open_topic('Auth_Options');
         $user_data_html = <<END;
@@ -1109,26 +1112,29 @@ sub print_enroll_single_student_form {
 </table>
 <h3>$lt{'pswd'}</h3>
 $lt{'psam'}$authhelp
-<table>
 <p>
-$krbform
-<br />
-$intform
-<br />
-$locform
-</p>
 END
+        if ($krbform ne '') {
+            $user_data_html .= $krbform.'<br />';
+        }
+        if ($intform ne '') {
+            $user_data_html .= $intform.'<br />';
+        }
+        if ($locform ne '') {
+            $user_data_html .= $locform.'<br />';
+        }
+        $user_data_html .= "\n</p>\n"
     } else {
         # User already exists.  Do not worry about authentication
         my %uenv = &Apache::lonnet::dump('environment',$ccdomain,$ccuname);
-        $javascript_validations = &javascript_validations('noauth');
+        $javascript_validations = &Apache::lonuserutils::javascript_validations('noauth');
 	my %lt=&Apache::lonlocal::texthash(
 		       'udf'  => "User Data for",
                        'fn'   => "First Name",
                        'mn'   => "Middle Name",
                        'ln'   => "Last Name",
                        'gen'  => "Generation",
-                       'mail' => "Email Address",
+                       'mail' => "E-mail Address",
 					   );
         $user_data_html = <<END;
 <h3>$lt{'udf'} $ccuname:$ccdomain</h3>
@@ -1147,7 +1153,7 @@ END
 </table>
 END
     }
-    my $date_table = &date_setting_table();
+    my $date_table = &Apache::lonuserutils::date_setting_table();
         # Print it all out
     my %lt=&Apache::lonlocal::texthash(
 		   'cd'   => "Course Data",
@@ -1236,7 +1242,14 @@ END
     return;
 }
 
-# ========================================================= Menu Phase Two Drop
+=pod
+
+=item print_drop_menu()
+
+    Menu Phase Two Drop
+
+=cut
+
 sub print_drop_menu {
     my $r=shift;
     $r->print("<h3>".&mt('Drop Students')."</h3>");
@@ -1251,7 +1264,15 @@ sub print_drop_menu {
     return;
 }
 
-# ============================================== view classlist
+
+=pod
+
+=item print_html_classlist()
+
+    view classlist
+
+=cut
+
 sub print_html_classlist {
     my ($r,$mode,$permission) = @_;
     if (! exists($env{'form.sortby'})) {
@@ -1341,7 +1362,15 @@ sub print_html_classlist {
     }
 }
 
-# =================================================== Show student list to drop
+
+=pod
+
+=item show_class_list()
+
+    Show student list to drop
+
+=cut
+
 sub show_class_list {
     my ($r,$mode,$linkto,$statusmode,$classlist,$keylist)=@_;
     my $cid=$env{'request.course.id'};
@@ -1396,7 +1425,7 @@ END
                                            'start'  => "start date",
                                            'end'    => "end date",
                                            'type'   => "enroll type/action",
-					   'email'  => "email address",
+					   'email'  => "e-mail address",
                                            'clicker'=> "clicker id",
                                            'photo'  => "photo",
 					   );
@@ -1499,9 +1528,9 @@ END
             time.'_'.rand(1000000000).'.csv';
 	unless ($CSVfile = Apache::File->new('>/home/httpd'.$CSVfilename)) {
 	    $r->log_error("Couldn't open $CSVfilename for output $!");
-	    $r->print("Problems occured in writing the csv file.  ".
-		      "This error has been logged.  ".
-		      "Please alert your LON-CAPA administrator.");
+	    $r->print(&mt('Problems occurred in writing the csv file. '
+                         .'This error has been logged. '
+                         .'Please alert your LON-CAPA administrator.'));
 	    $CSVfile = undef;
 	}
 	#
@@ -1743,9 +1772,14 @@ END
 }
 
 
-#
-# print out form for modification of a single students data
-#
+=pod
+
+=item print_modify_student_form()
+
+    print out form for modification of a single students data
+
+=cut
+
 sub print_modify_student_form {
     my $r = shift();
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
@@ -1796,7 +1830,8 @@ sub print_modify_student_form {
                 &Apache::lonlocal::locallocaltime($endtime)).'<br />';
 
     }
-    my $date_table = &date_setting_table($starttime,$endtime);
+    my $date_table = 
+        &Apache::lonuserutils::date_setting_table($starttime,$endtime);
     #
     if (! exists($env{'form.Status'}) || 
         $env{'form.Status'} !~ /^(Any|Expired|Active|Future)$/) {
@@ -1818,7 +1853,7 @@ sub print_modify_student_form {
                    'sm'    => "Submit Modifications",
 				       );
 # Check if section name is valid
-    my $section_check = &section_check_js();
+    my $section_check = &Apache::lonuserutils::section_check_js();
     $r->print(<<"END");
 <script type="text/javascript">
 $section_check
@@ -1873,9 +1908,15 @@ END
     return;
 }
 
-#
-# modify a single students section 
-#
+
+=pod 
+
+=item modify_single_student()
+
+    modify a single students section 
+
+=cut
+
 sub modify_single_student {
     my ($r) = @_;
     #
@@ -1883,9 +1924,10 @@ sub modify_single_student {
     $env{'form.section'} =~ s/\W//g;
     #
     # Do the date defaults first
-    my ($starttime,$endtime) = &get_dates_from_form();
+    my ($starttime,$endtime) = &Apache::lonuserutils::get_dates_from_form();
     if ($env{'form.makedatesdefault'}) {
-        $r->print(&make_dates_default($starttime,$endtime));
+        $r->print(&Apache::lonuserutils::make_dates_default($starttime,
+                                                            $endtime));
     }
     # Get the 'sortby' and 'Status' variables so the user goes back to their
     # previous screen
@@ -2031,11 +2073,12 @@ 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);
+    my $modify_section_results = 
+        &Apache::lonuserutils::modifystudent($sdom,$slogin,
+                                             $env{'request.course.id'},
+                                             $section,undef);
     if ($modify_section_results !~ /^ok/) {
-        $r->print(&mt('An error occured during the attempt to change the section for this student.')."<br />");
+        $r->print(&mt('An error occurred during the attempt to change the section for this student.')."<br />");
     }
     my $roleresults = &Apache::lonnet::modifystudent
         ($sdom,$slogin,$sid,undef,undef,$firstname,$middlename,$lastname,
@@ -2103,12 +2146,10 @@ sub get_enrollment_data {
     return ($start,$end,$section);
 }
 
-#################################################
-#################################################
 
 =pod
 
-=item show_drop_list
+=item show_drop_list()
 
 Display a list of students to drop
 Inputs: 
@@ -2128,8 +2169,6 @@ which describes the order elements are s
 
 =cut
 
-#################################################
-#################################################
 sub show_drop_list {
     my ($r,$classlist,$keylist,$nosort)=@_;
     my $cid=$env{'request.course.id'};
@@ -2289,9 +2328,15 @@ END
     return;
 }
 
-#
-# Print out the initial form to get the courselist file
-#
+
+=pod 
+
+=item print_first_courselist_upload_form()
+
+    Print out the initial form to get the courselist file
+
+=cut
+
 sub print_first_courselist_upload_form {
     my $r=shift;
     my $str;
@@ -2316,7 +2361,15 @@ sub print_first_courselist_upload_form {
     return;
 }
 
-# ================================================= Drop/Add from uploaded file
+
+=pod
+
+=item upfile_drop_add()
+
+    Drop/Add from uploaded file
+
+=cut
+
 sub upfile_drop_add {
     my $r=shift;
     &Apache::loncommon::load_tmp_file($r);
@@ -2493,8 +2546,9 @@ sub upfile_drop_add {
                         $$_ =~ s/(\s+$|^\s+)//g;
                     }
                     if ($password || $env{'form.login'} eq 'loc') {
-                        &modifystudent($domain,$username,$cid,$sec,
-                                       $desiredhost);
+                        &Apache::lonuserutils::modifystudent($domain,
+                                                         $username,$cid,
+                                                         $sec,$desiredhost);
                         my $reply=&Apache::lonnet::modifystudent
                             ($domain,$username,$id,$amode,$password,
                              $fname,$mname,$lname,$gen,$sec,$enddate,
@@ -2521,7 +2575,7 @@ sub upfile_drop_add {
                 }
             }
         } # end of foreach (@studentdata)
-        $r->print("</p>\n<p>\n".&mt('Processed [_1] student(s).',$count).
+        $r->print("</p>\n<p>\n".&mt('Processed [quant,_1,student].',$count).
                   "</p>\n");
         $r->print("<p>\n".
                   &mt('If active, the new role will be available when the '.
@@ -2561,7 +2615,8 @@ sub drop_student_list {
     foreach (@droplist) {
         my ($uname,$udom)=split(/\:/,$_);
         # drop student
-        my $result = &modifystudent($udom,$uname,$env{'request.course.id'});
+        my $result = &Apache::lonuserutils::modifystudent($udom,$uname,
+                                                $env{'request.course.id'});
         if ($result eq 'ok' || $result eq 'ok:') {
             $r->print(&mt('Dropped [_1]',$uname.'@'.$udom).'<br>');
             $count++;
@@ -2571,7 +2626,7 @@ sub drop_student_list {
                       '<br />');
         }
     }
-    $r->print('<p><b>'.&mt('Dropped [_1] student(s).',$count).'</b></p>');
+    $r->print('<p><b>'.&mt('Dropped [quant,_1,student].',$count).'</b></p>');
     $r->print('<p>'.&mt('Re-enrollment will re-activate data.')) if ($count);
 }
 
@@ -2628,12 +2683,9 @@ sub get_permission {
     return (\%permission,$allowed);
 }
 
-###################################################################
-###################################################################
-
 =pod
 
-=item &handler
+=item &handler()
 
 The typical handler you see in all these modules.  Takes $r, the
 http request, as an argument.  
@@ -2660,8 +2712,6 @@ The response to the request is governed
 
 =cut
 
-###################################################################
-###################################################################
 sub handler {
     my $r=shift;
     if ($r->header_only) {
@@ -2746,14 +2796,19 @@ sub handler {
         my @search = ('srchterm','srchby','srchin','srchtype','srchdomain');
         my ($jsback,$elements) = &Apache::loncreateuser::crumb_utilities();
         my $jscript = '<script type="text/javascript">'.$jsback.'</script>';
+	&Apache::loncreateuser::restore_prev_selections();
+	my $srch;
+	foreach my $item (@search) {
+	    $srch->{$item} = $env{'form.'.$item};
+	}
+
         if ($env{'form.state'} eq 'gotusername') {
-            my $srch;
-            foreach my $item (@search) {
-                $srch->{$item} = $env{'form.'.$item};
-            }
             if ($env{'form.phase'} eq 'get_user_info') {
                 my ($currstate,$response,$forcenewuser,$results) =
                     &Apache::loncreateuser::user_search_result($srch);
+                if ($env{'form.currstate'} eq 'modify') {
+                    $currstate = $env{'form.currstate'};
+                }
                 if ($currstate eq 'select') {
                     $r->print(&header());
                     &Apache::lonhtmlcommon::add_breadcrumb
@@ -2797,7 +2852,7 @@ sub handler {
                 &print_enroll_single_student_form($r,$jscript,$ccuname,
                                                   $ccdomain,$srch);
             } else {
-                &get_student_username_domain_form($r,$elements);
+                &get_student_username_domain_form($r,$elements,undef,$srch);
             }
         } elsif ($env{'form.state'} eq 'enrolling') {
             $r->print(&header($jscript));
@@ -2818,7 +2873,7 @@ sub handler {
                                                       'Course_Add_Student'));
             &enroll_single_student($r,\@search);
         } else {
-            &get_student_username_domain_form($r,$elements);
+            &get_student_username_domain_form($r,$elements,undef,$srch);
         }
     } elsif ($env{'form.action'} eq 'classlist' && $permission->{'view'}) {
         $r->print(&header());
@@ -2867,10 +2922,12 @@ sub handler {
     return OK;
 }
 
-###################################################################
-###################################################################
 
 1;
 __END__
 
+=pod
+
+=back
 
+=cut