--- loncom/interface/lonhelper.pm	2008/12/13 04:36:28	1.166.2.1
+++ loncom/interface/lonhelper.pm	2009/06/15 11:18:11	1.176
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # .helper XML handler to implement the LON-CAPA helper
 #
-# $Id: lonhelper.pm,v 1.166.2.1 2008/12/13 04:36:28 raeburn Exp $
+# $Id: lonhelper.pm,v 1.176 2009/06/15 11:18:11 bisitz 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();
     }
@@ -587,78 +589,75 @@ 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">'; }
     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 .= '<span class="LC_nobreak"><input name="back" type="button" ';
-            $result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
-            $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></span>';
+            $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 .= '<span class="LC_nobreak"><input name="back" type="button" ';
-            $result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
-            $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></span>';
-        }
+        $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
 
@@ -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);
     }
@@ -2446,6 +2448,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});
@@ -3421,7 +3438,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 +3545,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 +3557,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 +3648,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 +3663,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 +3685,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 +3710,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 +3727,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 +3778,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 +3806,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 +3827,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;
 }