--- loncom/interface/lonhelper.pm	2003/05/27 19:59:38	1.34
+++ loncom/interface/lonhelper.pm	2003/08/13 14:49:58	1.42
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # .helper XML handler to implement the LON-CAPA helper
 #
-# $Id: lonhelper.pm,v 1.34 2003/05/27 19:59:38 bowersj2 Exp $
+# $Id: lonhelper.pm,v 1.42 2003/08/13 14:49:58 bowersj2 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -779,6 +779,18 @@ some setting accidentally.
 
 Again, see the course initialization helper for examples.
 
+B<validator tag>
+
+Some elements that accepts user input can contain a "validator" tag that,
+when surrounded by "sub { my $helper = shift; my $state = shift; my $element = shift; my $val = shift " 
+and "}", where "$val" is the value the user entered, will form a subroutine 
+that when called will verify whether the given input is valid or not. If it 
+is valid, the routine will return a false value. If invalid, the routine 
+will return an error message to be displayed for the user.
+
+Consult the documentation for each element to see whether it supports this 
+tag.
+
 B<getValue method>
 
 If the element stores the name of the variable in a 'variable' member, which
@@ -790,7 +802,7 @@ this method.
 BEGIN {
     &Apache::lonhelper::register('Apache::lonhelper::element',
                                  ('nextstate', 'finalcode',
-                                  'defaultvalue'));
+                                  'defaultvalue', 'validator'));
 }
 
 # Because we use the param hash, this is often a sufficent
@@ -855,6 +867,22 @@ sub start_defaultvalue {
 
 sub end_defaultvalue { return ''; }
 
+sub start_validator {
+    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+    if ($target ne 'helper') {
+        return '';
+    }
+    
+    $paramHash->{VALIDATOR} = &Apache::lonxml::get_all_text('/validator',
+                                                             $parser);
+    $paramHash->{VALIDATOR} = 'sub { my $helper = shift; my $state = shift; my $element = shift; my $val = shift;' .
+        $paramHash->{VALIDATOR} . '}';
+    return '';
+}
+
+sub end_validator { return ''; }
+
 sub preprocess {
     return 1;
 }
@@ -1114,7 +1142,6 @@ sub end_choice {
 }
 
 sub render {
-    # START HERE: Replace this with correct choices code.
     my $self = shift;
     my $var = $self->{'variable'};
     my $buttons = '';
@@ -1247,6 +1274,153 @@ sub postprocess {
 }
 1;
 
+package Apache::lonhelper::dropdown;
+
+=pod
+
+=head2 Element: dropdown
+
+A drop-down provides a drop-down box instead of a radio button
+box. Because most people do not know how to use a multi-select
+drop-down box, that option is not allowed. Otherwise, the arguments
+are the same as "choices", except "allowempty" is also meaningless.
+
+<dropdown> takes an attribute "variable" to control which helper variable
+the result is stored in.
+
+B<SUB-TAGS>
+
+<choice>, which acts just as it does in the "choices" element.
+
+=back
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+
+BEGIN {
+    &Apache::lonhelper::register('Apache::lonhelper::dropdown',
+                              ('dropdown'));
+}
+
+sub new {
+    my $ref = Apache::lonhelper::element->new();
+    bless($ref);
+}
+
+# CONSTRUCTION: Construct the message element from the XML
+sub start_dropdown {
+    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+    if ($target ne 'helper') {
+        return '';
+    }
+
+    # Need to initialize the choices list, so everything can assume it exists
+    $paramHash->{'variable'} = $token->[2]{'variable'} if (!defined($paramHash->{'variable'}));
+    $helper->declareVar($paramHash->{'variable'});
+    $paramHash->{CHOICES} = [];
+    return '';
+}
+
+sub end_dropdown {
+    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+    if ($target ne 'helper') {
+        return '';
+    }
+    Apache::lonhelper::dropdown->new();
+    return '';
+}
+
+sub render {
+    my $self = shift;
+    my $var = $self->{'variable'};
+    my $result = '';
+
+    if (defined $self->{ERROR_MSG}) {
+        $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br />';
+    }
+
+    my %checkedChoices;
+    my $checkedChoicesFunc;
+
+    if (defined($self->{DEFAULT_VALUE})) {
+        $checkedChoicesFunc = eval ($self->{DEFAULT_VALUE});
+        die 'Error in default value code for variable ' . 
+            $self->{'variable'} . ', Perl said: ' . $@ if $@;
+    } else {
+        $checkedChoicesFunc = sub { return ''; };
+    }
+
+    # single choice
+    my $selectedChoice = &$checkedChoicesFunc($helper, $self);
+    
+    my $foundChoice = 0;
+    
+    # check that the choice is in the list of choices.
+    for my $choice (@{$self->{CHOICES}}) {
+	if ($choice->[1] eq $selectedChoice) {
+	    $checkedChoices{$choice->[1]} = 1;
+	    $foundChoice = 1;
+	}
+    }
+    
+    # If we couldn't find the choice, pick the first one 
+    if (!$foundChoice) {
+	$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
+    }
+
+    $result .= "<select name='${var}.forminput'>\n";
+    foreach my $choice (@{$self->{CHOICES}}) {
+        $result .= "<option value='" . 
+            HTML::Entities::encode($choice->[1]) 
+            . "'";
+        if ($checkedChoices{$choice->[1]}) {
+            $result .= " selected";
+        }
+        my $choiceLabel = $choice->[0];
+        if ($choice->[4]) {  # if we need to evaluate this choice
+            $choiceLabel = "sub { my $helper = shift; my $state = shift;" .
+                $choiceLabel . "}";
+            $choiceLabel = eval($choiceLabel);
+            $choiceLabel = &$choiceLabel($helper, $self);
+        }
+        $result .= ">" . $choiceLabel . "\n";
+    }
+
+    return $result;
+}
+
+# If a NEXTSTATE was given or a nextstate for this choice was
+# given, switch to it
+sub postprocess {
+    my $self = shift;
+    my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'};
+
+    if (!defined($chosenValue) && !$self->{'allowempty'}) {
+        $self->{ERROR_MSG} = "You must choose one or more choices to" .
+            " continue.";
+        return 0;
+    }
+
+    if (defined($self->{NEXTSTATE})) {
+        $helper->changeState($self->{NEXTSTATE});
+    }
+    
+    foreach my $choice (@{$self->{CHOICES}}) {
+        if ($choice->[1] eq $chosenValue) {
+            if (defined($choice->[2])) {
+                $helper->changeState($choice->[2]);
+            }
+        }
+    }
+    return 1;
+}
+1;
+
 package Apache::lonhelper::date;
 
 =pod
@@ -1694,6 +1868,10 @@ BUTTONS
                 $col .= "checked ";
                 $checked = 1;
             }
+	    if ($multichoice) { # all resources start checked; see bug 1174
+		$col .= "checked ";
+		$checked = 1;
+	    }
             $col .= "value='" . 
                 HTML::Entities::encode(&$valueFunc($resource)) 
                 . "' /></td>";
@@ -1743,9 +1921,10 @@ package Apache::lonhelper::student;
 Student elements display a choice of students enrolled in the current
 course. Currently it is primitive; this is expected to evolve later.
 
-Student elements take two attributes: "variable", which means what
-it usually does, and "multichoice", which if true allows the user
-to select multiple students.
+Student elements take three attributes: "variable", which means what
+it usually does, "multichoice", which if true allows the user
+to select multiple students, and "coursepersonnel" which if true 
+adds the course personnel to the top of the student selection.
 
 =cut
 
@@ -1775,6 +1954,7 @@ sub start_student {
     $paramHash->{'variable'} = $token->[2]{'variable'};
     $helper->declareVar($paramHash->{'variable'});
     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+    $paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
     if (defined($token->[2]{'nextstate'})) {
         $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
     }
@@ -1821,30 +2001,60 @@ BUTTONS
         $result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
     }
 
-    # Load up the students
-    my $choices = &Apache::loncoursedata::get_classlist();
-    my @keys = keys %{$choices};
+    my $choices = [];
+
+    # Load up the non-students, if necessary
+    if ($self->{'coursepersonnel'}) {
+	my %coursepersonnel = Apache::lonnet::get_course_adv_roles();
+	for (sort keys %coursepersonnel) {
+	    for my $role (split /,/, $coursepersonnel{$_}) {
+		# extract the names so we can sort them
+		my @people;
+		
+		for (split /,/, $role) {
+		    push @people, [split /:/, $role];
+		}
+		
+		@people = sort { $a->[0] cmp $b->[0] } @people;
+		
+		for my $person (@people) {
+		    push @$choices, [join(':', @$person), $person->[0], '', $_];
+		}
+	    }
+	}
+    }
 
     # Constants
     my $section = Apache::loncoursedata::CL_SECTION();
     my $fullname = Apache::loncoursedata::CL_FULLNAME();
 
+    # Load up the students
+    my $classlist = &Apache::loncoursedata::get_classlist();
+    my @keys = keys %{$classlist};
     # Sort by: Section, name
     @keys = sort {
-        if ($choices->{$a}->[$section] ne $choices->{$b}->[$section]) {
-            return $choices->{$a}->[$section] cmp $choices->{$b}->[$section];
+        if ($classlist->{$a}->[$section] ne $classlist->{$b}->[$section]) {
+            return $classlist->{$a}->[$section] cmp $classlist->{$b}->[$section];
         }
-        return $choices->{$a}->[$fullname] cmp $choices->{$b}->[$fullname];
+        return $classlist->{$a}->[$fullname] cmp $classlist->{$b}->[$fullname];
     } @keys;
 
+    # username, fullname, section, type
+    for (@keys) {
+	push @$choices, [$_, $classlist->{$_}->[$fullname], 
+			 $classlist->{$_}->[$section], 'Student'];
+    }
+
+    my $name = $self->{'coursepersonnel'} ? 'Name' : 'Student Name';
     my $type = 'radio';
     if ($self->{'multichoice'}) { $type = 'checkbox'; }
     $result .= "<table cellspacing='2' cellpadding='2' border='0'>\n";
-    $result .= "<tr><td></td><td align='center'><b>Student Name</b></td>".
-        "<td align='center'><b>Section</b></td></tr>";
+    $result .= "<tr><td></td><td align='center'><b>$name</b></td>".
+        "<td align='center'><b>Section</b></td>" . 
+	"<td align='center'><b>Role</b></td></tr>";
 
     my $checked = 0;
-    foreach (@keys) {
+    for my $choice (@$choices) {
         $result .= "<tr><td><input type='$type' name='" .
             $self->{'variable'} . '.forminput' . "'";
             
@@ -1853,12 +2063,13 @@ BUTTONS
             $checked = 1;
         }
         $result .=
-            " value='" . HTML::Entities::encode($_ . ':' . $choices->{$_}->[$section])
+            " value='" . HTML::Entities::encode($choice->[0] . ':' . $choice->[2])
             . "' /></td><td>"
-            . HTML::Entities::encode($choices->{$_}->[$fullname])
+            . HTML::Entities::encode($choice->[1])
             . "</td><td align='center'>" 
-            . HTML::Entities::encode($choices->{$_}->[$section])
-            . "</td></tr>\n";
+            . HTML::Entities::encode($choice->[2])
+            . "</td>\n<td>" 
+	    . HTML::Entities::encode($choice->[3]) . "</td></tr>\n";
     }
 
     $result .= "</table>\n\n";
@@ -2262,6 +2473,8 @@ also pass through 'maxlength' and 'size'
 
 string honors the defaultvalue tag, if given.
 
+string honors the validation function, if given.
+
 =cut
 
 no strict;
@@ -2307,7 +2520,13 @@ sub end_string {
 
 sub render {
     my $self = shift;
-    my $result = '<input type="string" name="' . $self->{'variable'} . '.forminput"';
+    my $result = '';
+
+    if (defined $self->{ERROR_MSG}) {
+        $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
+    }
+
+    $result .= '<input type="string" name="' . $self->{'variable'} . '.forminput"';
 
     if (defined($self->{'size'})) {
         $result .= ' size="' . $self->{'size'} . '"';
@@ -2331,8 +2550,19 @@ sub render {
 # If a NEXTSTATE was given, switch to it
 sub postprocess {
     my $self = shift;
-    if (defined($self->{NEXTSTATE})) {
-        $helper->changeState($self->{NEXTSTATE});
+
+    if (defined($self->{VALIDATOR})) {
+	my $validator = eval($self->{VALIDATOR});
+	die 'Died during evaluation of evaulation code; Perl said: ' . $@ if $@;
+	my $invalid = &$validator($helper, $state, $self, $self->getValue());
+	if ($invalid) {
+	    $self->{ERROR_MSG} = $invalid;
+	    return 0;
+	}
+    }
+
+    if (defined($self->{'nextstate'})) {
+        $helper->changeState($self->{'nextstate'});
     }
 
     return 1;
@@ -2570,31 +2800,33 @@ sub render {
         }
     }
 
-    if (scalar(@results) == 0) {
-        return '';
-    }
-
-    my $result = "<ul>\n";
-    for my $re (@results) {
-        $result .= '    <li>' . $re . "</li>\n";
-    }
+    my $result;
 
-    if (!@results) {
-        $result .= '    <li>No changes were made to current settings.</li>';
+    if (scalar(@results) != 0) {
+	$result .= "<ul>\n";
+	for my $re (@results) {
+	    $result .= '    <li>' . $re . "</li>\n";
+	}
+	
+	if (!@results) {
+	    $result .= '    <li>No changes were made to current settings.</li>';
+	}
+	
+	$result .= '</ul>';
     }
 
     if ($self->{'restartCourse'}) {
         $result .= "<center>\n" .
             "<form action='/adm/roles' method='post' target='loncapaclient'>\n" .
             "<input type='button' onclick='history.go(-1)' value='&lt;- Previous' />" .
-            "<input type='hidden' name='orgurl' value='/adm/navmaps' />" .
+            "<input type='hidden' name='orgurl' value='/adm/menu' />" .
             "<input type='hidden' name='selectrole' value='1' />\n" .
             "<input type='hidden' name='" . $ENV{'request.role'} . 
             "' value='1' />\n<input type='submit' value='Finish Course Initialization' />\n" .
             "</form></center>";
     }
 
-    return $result . '</ul>';
+    return $result;
 }
 
 sub overrideForm {
@@ -2646,10 +2878,13 @@ sub render {
     # FIXME: Unify my designators with the standard ones
     my %dateTypeHash = ('open_date' => "Opening Date",
                         'due_date' => "Due Date",
-                        'answer_date' => "Answer Date");
+                        'answer_date' => "Answer Date",
+			'tries' => 'Number of Tries'
+			);
     my %parmTypeHash = ('open_date' => "0_opendate",
                         'due_date' => "0_duedate",
-                        'answer_date' => "0_answerdate");
+                        'answer_date' => "0_answerdate",
+			'tries' => '0_maxtries' );
     
     my $affectedResourceId = "";
     my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}};
@@ -2666,10 +2901,8 @@ sub render {
         $symb = 'a';
         $paramlevel = 'general';
     } elsif ($vars->{GRANULARITY} eq 'map') {
-        my $navmap = Apache::lonnavmaps::navmap->new(
-                           $ENV{"request.course.fn"}.".db",
-                           $ENV{"request.course.fn"}."_parms.db", 0, 0);
-        my $res = $navmap->getById($vars->{RESOURCE_ID});
+        my $navmap = Apache::lonnavmaps::navmap->new();
+        my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
         my $title = $res->compTitle();
         $symb = $res->symb();
         $navmap->untieHashes();
@@ -2678,9 +2911,7 @@ sub render {
         $affectedResourceId = $vars->{RESOURCE_ID};
         $paramlevel = 'map';
     } else {
-        my $navmap = Apache::lonnavmaps::navmap->new(
-                           $ENV{"request.course.fn"}.".db",
-                           $ENV{"request.course.fn"}."_parms.db", 0, 0);
+        my $navmap = Apache::lonnavmaps::navmap->new();
         my $res = $navmap->getById($vars->{RESOURCE_ID});
         $symb = $res->symb();
         my $title = $res->compTitle();
@@ -2695,8 +2926,11 @@ sub render {
     $result .= '<p>Confirm that this information is correct, then click &quot;Finish Wizard&quot; to complete setting the parameter.<ul>';
     
     # Print the type of manipulation:
-    $result .= '<li>Setting the <b>' . $dateTypeHash{$vars->{ACTION_TYPE}}
-               . "</b></li>\n";
+    $result .= '<li>Setting the <b>' . $dateTypeHash{$vars->{ACTION_TYPE}} . '</b>';
+    if ($vars->{ACTION_TYPE} eq 'tries') {
+	$result .= ' to <b>' . $vars->{TRIES} . '</b>';
+    }
+    $result .= "</li>\n";
     if ($vars->{ACTION_TYPE} eq 'due_date' || 
         $vars->{ACTION_TYPE} eq 'answer_date') {
         # for due dates, we default to "date end" type entries
@@ -2713,7 +2947,10 @@ sub render {
             "value='" . $vars->{PARM_DATE} . "' />\n";
         $result .= "<input type='hidden' name='pres_type' " .
             "value='date_start' />\n";
-    } 
+    } elsif ($vars->{ACTION_TYPE} eq 'tries') {
+	$result .= "<input type='hidden' name='pres_value' " .
+	    "value='" . $vars->{TRIES} . "' />\n";
+    }
 
     $result .= $resourceString;
     
@@ -2743,10 +2980,12 @@ sub render {
     }
 
     # Print value
-    $result .= "<li>to <b>" . ctime($vars->{PARM_DATE}) . "</b> (" .
-        Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}) 
-        . ")</li>\n";
-
+    if ($vars->{ACTION_TYPE} ne 'tries') {
+	$result .= "<li>to <b>" . ctime($vars->{PARM_DATE}) . "</b> (" .
+	    Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}) 
+	    . ")</li>\n";
+    }
+ 
     # print pres_marker
     $result .= "\n<input type='hidden' name='pres_marker'" .
         " value='$affectedResourceId&$parm_name&$level' />\n";