--- loncom/interface/lonhelper.pm	2008/09/17 15:53:34	1.166
+++ loncom/interface/lonhelper.pm	2010/09/02 00:19:17	1.180.2.2
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # .helper XML handler to implement the LON-CAPA helper
 #
-# $Id: lonhelper.pm,v 1.166 2008/09/17 15:53:34 raeburn Exp $
+# $Id: lonhelper.pm,v 1.180.2.2 2010/09/02 00:19:17 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -188,6 +188,8 @@ use Apache::lonlocal;
 use Apache::lonnet;
 use Apache::longroup;
 use Apache::lonselstudent;
+
+
 use LONCAPA;
 
 # Register all the tags with the helper, so the helper can 
@@ -529,7 +531,7 @@ sub process {
     # Phase 1: Post processing for state of previous screen (which is actually
     # the "current state" in terms of the helper variables), if it wasn't the 
     # beginning state.
-    if ($self->{STATE} ne "START" || $env{"form.SUBMIT"} eq &mt("Next ->")) {
+    if ($self->{STATE} ne "START" || $env{"form.SUBMIT"} eq &mt("Next")) {
 	my $prevState = $self->{STATES}{$self->{STATE}};
         $prevState->postprocess();
     }
@@ -569,7 +571,7 @@ sub process {
 # 4: Render the current state to the screen as an HTML page.
 sub display {
     my $self = shift;
-
+    my $footer = shift;
     my $state = $self->{STATES}{$self->{STATE}};
 
     my $result = "";
@@ -587,82 +589,79 @@ sub display {
 	&Apache::loncommon::browser_and_searcher_javascript().
 	"\n".'</script>';
 
+    # Breadcrumbs
+    my $brcrum = [{'href' => '',
+                   'text' => 'Helper'}];
+    # FIXME: Dynamically add context sensitive breadcrumbs
+    #        depending on the caller,
+    #        e.g. printing, parametrization, etc.
+    # FIXME: Add breadcrumbs to reflect current helper state
+
     $result .= &Apache::loncommon::start_page($self->{TITLE},
-					      $browser_searcher_js);
-    
-    my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
-    my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
+                                              $browser_searcher_js,
+                                              {'bread_crumbs' => $brcrum,});
+
+    my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
+    my $next = HTML::Entities::encode(&mt("Next"), '<>&"');
     # FIXME: This should be parameterized, not concatenated - Jeremy
 
 
-    if (!$state->overrideForm()) { $result.="<form name='helpform' method='POST'>"; }
+    if (!$state->overrideForm()) { $result.='<form name="helpform" method="post" action="">'; }
     if ($stateHelp) {
-	$stateHelp = &Apache::loncommon::help_open_topic($stateHelp);
+        $stateHelp = &Apache::loncommon::help_open_topic($stateHelp);
     }
-    $result .= <<HEADER;
-        <table border="0" width='100%'><tr><td>
-        <h2><i>$stateTitle</i>$stateHelp</h2>
-HEADER
-
-    $result .= "<table cellpadding='10' width='100%'><tr><td rowspan='2' valign='top'>";
 
-    if (!$state->overrideForm()) {
-        $result .= $self->_saveVars();
-    }
-    $result .= $state->render();
-
-    $result .= "</td><td valign='top' align='right'>";
-
-    # Warning: Copy and pasted from below, because it's too much trouble to 
-    # turn this into a subroutine
+    # Prepare buttons
+    my $buttons;
     if (!$state->overrideForm()) {
         if ($self->{STATE} ne $self->{START_STATE}) {
             #$result .= '<input name="SUBMIT" type="submit" value="&lt;- Previous" />&nbsp;&nbsp;';
         }
+        $buttons = '<p>'; # '<fieldset>';
         if ($self->{DONE}) {
             my $returnPage = $self->{RETURN_PAGE};
-            $result .= "<a href=\"$returnPage\">" . &mt("End Helper") . "</a>";
+            $buttons .= '<a href="'.$returnPage.'">'.&mt('End Helper').'</a>';
         }
         else {
-            $result .= '<nobr><input name="back" type="button" ';
-            $result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
-            $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
+            $buttons .= '<span class="LC_nobreak">'
+                       .'<input name="back" type="button" '
+                       .'value="'.$previous.'" onclick="history.go(-1)" /> '
+                       .'<input name="SUBMIT" type="submit" value="'.$next.'" />'
+                       .'</span>';
         }
+    $buttons .= '</p>'; # '</fieldset>';
     }
 
-    $result .= "</td></tr><tr><td valign='bottom' align='right'>";
 
-    # Warning: Copy and pasted from above, because it's too much trouble to 
-    # turn this into a subroutine
+
+    $result .= '<h2>'.$stateTitle.$stateHelp.'</h2>';
+
+#   $result .= '<div>';
+
+    # Top buttons
+    $result .= $buttons;
+
+    # Main content of current helper screen
     if (!$state->overrideForm()) {
-        if ($self->{STATE} ne $self->{START_STATE}) {
-            #$result .= '<input name="SUBMIT" type="submit" value="&lt;- Previous" />&nbsp;&nbsp;';
-        }
-        if ($self->{DONE}) {
-            my $returnPage = $self->{RETURN_PAGE};
-            $result .= "<a href=\"$returnPage\">" . &mt('End Helper') . "</a>";
-        }
-        else {
-            $result .= '<nobr><input name="back" type="button" ';
-            $result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
-            $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
-        }
+        $result .= $self->_saveVars();
     }
+    $result .= $state->render();
+
+    # Bottom buttons
+    $result .= $buttons;
+
 
     #foreach my $key (keys %{$self->{VARS}}) {
     #    $result .= "|$key| -> " . $self->{VARS}->{$key} . "<br />";
     #}
 
-    $result .= "</td></tr></table>";
+#   $result .= '</div>';
 
     $result .= <<FOOTER;
-              </td>
-            </tr>
-          </table>
         </form>
 FOOTER
 
-    $result .= &Apache::loncommon::end_page();
+    $result .= $footer.&Apache::loncommon::end_page();
     # Handle writing out the vars to the file
     my $file = Apache::File->new('>'.$self->{FILENAME});
     print $file $self->_varsInFile();
@@ -1508,12 +1507,15 @@ sub postprocess {
     my $self = shift;
     my $chosenValue = $env{'form.' . $self->{'variable'} . '_forminput'};
 
+
     if (!defined($chosenValue) && !$self->{'allowempty'}) {
         $self->{ERROR_MSG} = 
 	    &mt("You must choose one or more choices to continue.");
         return 0;
     }
 
+
+
     if (ref($chosenValue)) {
         $helper->{VARS}->{$self->{'variable'}} = join('|||', @$chosenValue);
     }
@@ -2064,6 +2066,49 @@ the toplevel default.sequence in the res
   evaluated with "sub { my $helper = shift; my $state = shift;" and
   "}", with the return value used as the mapurl.
 
+=item * <option />: Allows you to add optional elements to the
+  resource chooser currently these can be a checkbox, or a text entry
+  or hidden (see the 'type' attribute below).
+  the following attributes are supported by this tag:
+
+=over 4
+
+=item * type=control-type : determines the type of control displayed.
+  This can be one of the following types: 'checkbox' provides a true/false
+  checkbox.  'text' provides a text entry control. 'hidden' provides a
+  hidden form element that returns the name of the resource for each
+  element of the text box.
+
+=item * text=header-text : provides column header text for the option.
+  
+=item * variable=helpervar : provides a helper variable to contain the
+  value of the input control for each resource.  In general, the result
+  will be a set of values separated by |||  for the checkbox the value between
+  the |||'s will either be empty, if the box is not checked, or the resource
+  name if checked.  For the text entry, the values will be the text in the
+  text box.  This could be empty.  Hidden elements unconditionally provide
+  the resource name for each row of the chooser and allow you to therefore
+  correlate text entries to their resources.
+  The helper variable can be initialized by the user code to pre-load values
+  into the controls:
+
+=over 4
+
+  
+=item * Preloading checkboxes : Set the helper variable to the value you
+   would have gotten from the control if it had been manually set as desired.
+
+=item * Preloading text entries : Set the helper variable to triple pipe
+   separated values where each value is of the form resource-name=value
+
+=item * Preloading hidden fields : These cannot be pre-loaded and will always
+  be pipe separated resource names.
+
+=back
+
+
+=back
+
 =back
 
 =cut
@@ -2193,20 +2238,42 @@ sub start_option {
     if (!defined($paramHash->{OPTION_TEXTS})) {
 	$paramHash->{OPTION_TEXTS} = [ ];
 	$paramHash->{OPTION_VARS}  = [ ];
+	$paramHash->{OPTION_TYPES} = [ ];
 
     }
+    #  We can have an attribute: type which can have the
+    #  values: "checkbox" or "text" which defaults to 
+    #           checkbox allowing us to change the type of input
+    #           for the option:
+    #
+    my $input_widget_type = 'checkbox';
+    if(defined($token->[2]{'type'})) {
+	my $widget_type  = $token->[2]{'type'};
+	if ($widget_type eq 'text') {          # only accept legal alternatives
+	    $input_widget_type = $widget_type; # Illegals are checks.
+	} elsif ($widget_type eq 'hidden') {
+	    $input_widget_type = $widget_type;
+	}
+    }
+
     # OPTION_TEXTS is a list of the text attribute
     #               values used to create column headings.
     # OPTION_VARS is a list of the variable names, used to create the checkbox
     #             inputs.
+    # OPTION_TYPES is a list of the option types:
+    #
     #  We're ok with empty elements. as place holders
     # Although the 'variable' element should really exist.
     #
 
+
     my $option_texts  = $paramHash->{OPTION_TEXTS};
     my $option_vars   = $paramHash->{OPTION_VARS};
+    my $option_types   = $paramHash->{OPTION_TYPES};
     push(@$option_texts,  $token->[2]{'text'});
     push(@$option_vars,   $token->[2]{'variable'});
+    push(@$option_types,   $input_widget_type);
+
 
     #  Need to create and declare the option variables as well to make them
     # persistent.
@@ -2282,6 +2349,7 @@ BUTTONS
     my $multichoice    = $self->{'multichoice'};
     my $option_vars    = $self->{OPTION_VARS};
     my $option_texts   = $self->{OPTION_TEXTS};
+    my $option_types   = $self->{OPTION_TYPES};
     my $addparts       = $self->{'addparts'};
     my $headings_done  = 0;
 
@@ -2340,17 +2408,52 @@ BUTTONS
 	    my $resource_name =   
                    HTML::Entities::encode($raw_name,"<>&\"'");
 	    if($option_vars) {
+		my $option_num = 0;
 		foreach my $option_var (@$option_vars) {
+		    my $option_type = $option_types->[$option_num];
+		    $option_num++;
 		    my $var_value = "\|\|\|" . $helper->{VARS}->{$option_var} . 
 			"\|\|\|";
 		    my $checked ="";
 		    if($var_value =~ /\Q|||$raw_name|||\E/) {
 			$checked = "checked='checked'";
 		    }
-		    $col .= 
-                        "<td align='center'><input type='checkbox' name ='$option_var".
-			"_forminput' value='".
-			$resource_name . "' $checked /> </td>";
+		    if ($option_type eq 'text') {
+			#
+			# For text's the variable value is a ||| separated set of
+			# resource_name=value 
+			#
+			my @values = split(/\|\|\|/, $helper->{VARS}->{$option_var});
+
+			# Normal practice would be to toss this in a hash but 
+			# the only thing that saves is the compare in the loop
+			# below and for all but one case we'll break out of the loop
+			# before it completes.
+
+			my $text_value = '';    # In case there's no match.
+			foreach my $value (@values) {
+			    my ($res, $skip) = split(/=/, $value);
+			    if($res eq $resource_name) {
+				$text_value = $skip;
+				last;
+			    }
+			}
+			# TODO: add an attribute to <option> that allows the
+			#       programmer to set the width of the tex entry box.
+
+			$col .=
+			    "<td align='center'><input type='text' name ='$option_var".
+			    "_forminput' value='".$text_value."' size='5' /> </td>";
+		    } elsif ($option_type eq 'hidden') {
+ 			$col .= "<td align='center'><input type='hidden' name ='$option_var".
+			    "_forminput' value='".
+			    $resource_name . "'/> </td>";
+		    } else {
+			$col .= 
+			    "<td align='center'><input type=$option_type name ='$option_var".
+			    "_forminput' value='".
+			    $resource_name . "' $checked /> </td>";
+		    }
 		}
 	    }
 
@@ -2446,6 +2549,21 @@ sub postprocess {
         $self->{ERROR_MSG} = 'You must choose at least one resource to continue.';
         return 0;
     }
+    # For each of the attached options.  If it's env var is undefined, set it to
+    # an empty string instead.. an undef'd env var means no choices selected.
+    #
+
+    my $option_vars = $self->{OPTION_VARS};
+    if ($option_vars) {
+	foreach my $var (@$option_vars) {
+	    my $env_name = "form.".$var."_forminput";
+	    if (!defined($env{$env_name})) {
+		$env{$env_name} = '';
+		$helper->{VARS}->{$var} = '';
+	    }
+	}
+    }
+
 
     if (defined($self->{NEXTSTATE})) {
         $helper->changeState($self->{NEXTSTATE});
@@ -3171,6 +3289,10 @@ package Apache::lonhelper::string;
 string elements provide a string entry field for the user. string elements
 take the usual 'variable' and 'nextstate' parameters. string elements
 also pass through 'maxlength' and 'size' attributes to the input tag.
+Since you could have multiple strings in a helper state, each with its own
+validator, all but the last string should have
+noproceed='1' so that _all_ validators are evaluated before the next
+state can be reached.
 
 string honors the defaultvalue tag, if given.
 
@@ -3190,6 +3312,7 @@ BEGIN {
 
 sub new {
     my $ref = Apache::lonhelper::element->new();
+    $ref->{'PROCEED'} = 1;      # By default postprocess goes to next state.
     bless($ref);
 }
 
@@ -3206,20 +3329,33 @@ sub start_string {
     $paramHash->{'nextstate'} = $token->[2]{'nextstate'};
     $paramHash->{'maxlength'} = $token->[2]{'maxlength'};
     $paramHash->{'size'} = $token->[2]{'size'};
-
     return '';
 }
 
 sub end_string {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
 
+
     if ($target ne 'helper') {
         return '';
     }
-    Apache::lonhelper::string->new();
+    my $state = Apache::lonhelper::string->new();
+
+
+    if(&Apache::lonxml::get_param('noproceed', $parstack, $safeeval, undef, 1)) {
+	$state->noproceed();
+    }
+
+   
+
     return '';
 }
 
+sub noproceed() {
+    my $self = shift;
+    $self->{PROCEED}  = 0;
+}
+
 sub render {
     my $self = shift;
     my $result = '';
@@ -3263,7 +3399,7 @@ sub postprocess {
 	}
     }
 
-    if (defined($self->{'nextstate'})) {
+    if (defined($self->{'nextstate'}) && $self->{PROCEED}) {
         $helper->changeState($self->{'nextstate'});
     }
 
@@ -3421,7 +3557,7 @@ snippets and collecting the results. Fin
 helper, going to a provided page.
 
 If the parameter "restartCourse" is true, this will override the buttons and
-will make a "Finish Helper" button that will re-initialize the course for them,
+will make a Save button (Finish Helper) that will re-initialize the course for them,
 which is useful for the Course Initialization helper so the users never see
 the old values taking effect.
 
@@ -3528,7 +3664,7 @@ sub render {
 
     my $actionURL = $self->{EXIT_PAGE};
     my $targetURL = '';
-    my $finish=&mt('Finish');
+	my $finish=&mt('Save');
     if ($self->{'restartCourse'}) {
 	$actionURL = '/adm/roles';
 	$targetURL = '/adm/menu';
@@ -3540,21 +3676,19 @@ sub render {
 	if ($env{'course.'.$env{'request.course.id'}.'.clonedfrom'}) {
 	    $targetURL = '/adm/parmset?overview=1';
 	}
-	my $finish=&mt('Finish Course Initialization');
     }
-    my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
-    my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
+    my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
+    my $next = HTML::Entities::encode(&mt("Next"), '<>&"');
     my $target = " target='loncapaclient'";
-    if (($env{'browser.interface'} eq 'textual') ||
-        ($env{'environment.remote'} eq 'off')) {  $target='';  }
-    $result .= "<center>\n" .
+    if ($env{'environment.remote'} eq 'off') {  $target='';  }
+    $result .= "<p>\n" .
 	"<form action='".$actionURL."' method='post' $target>\n" .
 	"<input type='button' onclick='history.go(-1)' value='$previous' />" .
 	"<input type='hidden' name='orgurl' value='$targetURL' />" .
 	"<input type='hidden' name='selectrole' value='1' />\n" .
 	"<input type='hidden' name='" . $env{'request.role'} . 
 	"' value='1' />\n<input type='submit' value='" . $finish . "' />\n" .
-	"</form></center>";
+	"</form></p>\n";
 
     return $result;
 }
@@ -3633,7 +3767,7 @@ sub render {
     
     # Print the granularity, depending on the action
     if ($vars->{GRANULARITY} eq 'whole_course') {
-        $resourceString .= '<li>'.&mt('for <b>all resources in the course</b>').'</li>';
+        $resourceString .= '<li>'.&mt('for [_1]all resources in the course[_2]','<b>','</b>').'</li>';
 	if ($vars->{TARGETS} eq 'course') {
 	    $level = 14; # general course, see lonparmset.pm perldoc
 	} elsif ($vars->{TARGETS} eq 'section') {
@@ -3648,10 +3782,16 @@ sub render {
         $paramlevel = 'general';
     } elsif ($vars->{GRANULARITY} eq 'map') {
         my $navmap = Apache::lonnavmaps::navmap->new();
-        my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
-        my $title = $res->compTitle();
-        $symb = $res->symb();
-        $resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
+        if (defined($navmap)) {
+             my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
+             my $title = $res->compTitle();
+             $symb = $res->symb();
+             $resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
+        } else {
+            $resourceString .= '<li>'.&mt('for the map ID [_1] (name unavailable)','<b>'.$vars->{RESOURCE_ID}.'</b>').'</li>';
+            &Apache::lonnet::logthis('Retrieval of map title failed in lonhelper.pm - could not create navmap object for course.');
+
+        }
 	if ($vars->{TARGETS} eq 'course') {
 	    $level = 13; # general course, see lonparmset.pm perldoc
 	} elsif ($vars->{TARGETS} eq 'section') {
@@ -3664,13 +3804,18 @@ sub render {
         $affectedResourceId = $vars->{RESOURCE_ID};
         $paramlevel = 'map';
     } else {
-        my $navmap = Apache::lonnavmaps::navmap->new();
-        my $res = $navmap->getById($vars->{RESOURCE_ID});
         my $part = $vars->{RESOURCE_ID_part};
 	if ($part ne 'All Parts' && $part) { $parm_name=~s/^0/$part/; } else { $part=&mt('All Parts'); }
-        $symb = $res->symb();
-        my $title = $res->compTitle();
-        $resourceString .= '<li>'.&mt('for the resource named [_1] part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
+        my $navmap = Apache::lonnavmaps::navmap->new();
+        if (defined($navmap)) {
+            my $res = $navmap->getById($vars->{RESOURCE_ID});
+            $symb = $res->symb();
+            my $title = $res->compTitle();
+            $resourceString .= '<li>'.&mt('for the resource named [_1], part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
+        } else {
+            $resourceString .= '<li>'.&mt('for the resource ID [_1] (name unavailable), part [_2]','<b>'.$vars->{RESOURCE_ID}.'</b>',"<b>$part</b>").'</li>';
+            &Apache::lonnet::logthis('Retrieval of resource title failed in lonhelper.pm - could not create navmap object for course.');
+        }
 	if ($vars->{TARGETS} eq 'course') {
 	    $level = 10; # general course, see lonparmset.pm perldoc
 	} elsif ($vars->{TARGETS} eq 'section') {
@@ -3684,7 +3829,7 @@ sub render {
         $paramlevel = 'full';
     }
 
-    my $result = "<form name='helpform' method='POST' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";
+    my $result = "<form name='helpform' method='post' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";
     $result .= "<input type='hidden' name='action' value='settable' />\n";
     $result .= "<input type='hidden' name='dis' value='helper' />\n";
     $result .= "<input type='hidden' name='pscat' value='".
@@ -3701,7 +3846,10 @@ sub render {
     $result .= "<input type='hidden' name='psprt' value='".
 	HTML::Entities::encode($part,"'<>&\"") . "' />\n";
 
-    $result .= '<p>'.&mt('Confirm that this information is correct, then click &quot;Finish Helper&quot; to complete setting the parameter.').'<ul>';
+    $result .= '<p class="LC_info">'
+              .&mt('Confirm that this information is correct, then click &quot;Save&quot; to complete setting the parameter.')
+              .'</p>'
+              .'<ul>';
     
     # Print the type of manipulation:
     my $extra;
@@ -3749,7 +3897,7 @@ sub render {
     
     # Print targets
     if ($vars->{TARGETS} eq 'course') {
-        $result .= '<li>'.&mt('for <b>all students in course</b>').'</li>';
+        $result .= '<li>'.&mt('for [_1]all students in course[_2]','<b>','</b>').'</li>';
     } elsif ($vars->{TARGETS} eq 'section') {
         my $section = $vars->{SECTION_NAME};
         $result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';
@@ -3777,7 +3925,18 @@ sub render {
         my $showdate = &Apache::lonlocal::locallocaltime($vars->{PARM_DATE});
 	$result .= '<li>'.&mt('to [_1] ([_2])',"<b>".$showdate."</b>",Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}))."</li>\n";
     }
+
+	$result .= '</ul>';
  
+# FIXME: Make previous button working
+#        Found to be dysfunctional when used to change the selected student
+#   my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
+    my $buttons .= '<p><span class="LC_nobreak">'
+#                 .'<input name="back" type="button"'
+#                 .' value="'.$previous.'" onclick="history.go(-1)" />'
+                  .' <input type="submit" value="'.&mt('Save').'" />' # Finish Helper
+                  .'</span></p>'."\n";
+
     # print pres_marker
     $result .= "\n<input type='hidden' name='pres_marker'" .
         " value='$affectedResourceId&$parm_name&$level' />\n";
@@ -3787,7 +3946,7 @@ sub render {
     $result .= "\n<input type='hidden' value='$symb' name='pssymb' />";
     $result .= "\n<input type='hidden' value='$paramlevel' name='parmlev' />";
 
-    $result .= "<br /><br /><center><input type='submit' value='".&mt('Finish Helper')."' /></center></form>\n";
+    $result .= $buttons;
 
     return $result;
 }