--- loncom/interface/lonhelper.pm 2003/09/30 17:25:48 1.49 +++ loncom/interface/lonhelper.pm 2004/04/19 15:40:08 1.68 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # .helper XML handler to implement the LON-CAPA helper # -# $Id: lonhelper.pm,v 1.49 2003/09/30 17:25:48 bowersj2 Exp $ +# $Id: lonhelper.pm,v 1.68 2004/04/19 15:40:08 sakharuk Exp $ # # Copyright Michigan State University Board of Trustees # @@ -172,12 +172,20 @@ before parsing XML fragments and B<Apach when you are done. See lonprintout.pm for examples of this usage in the printHelper subroutine. +=head2 Localization + +The helper framework tries to handle as much localization as +possible. The text is always run through +Apache::lonlocal::normalize_string, so be sure to run the keys through +that function for maximum usefulness and robustness. + =cut package Apache::lonhelper; use Apache::Constants qw(:common); use Apache::File; use Apache::lonxml; +use Apache::lonlocal; # Register all the tags with the helper, so the helper can # push and pop them @@ -222,7 +230,7 @@ my $paramHash; # In the debugger, this means that breakpoints are ignored until you step into # a function and get out of what must be a "faked up scope" in the Apache-> # mod_perl connection. In this code, it was manifesting itself in the existence -# of two seperate file-scoped $helper variables, one set to the value of the +# of two separate file-scoped $helper variables, one set to the value of the # helper in the helper constructor, and one referenced by the handler on the # "$helper->process()" line. Using the debugger, one could actually # see the two different $helper variables, as hashes at completely @@ -257,9 +265,9 @@ sub real_handler { # Send header, don't cache this page if ($r->header_only) { if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); + $r->content_type('text/xml; charset=UTF-8'); } else { - $r->content_type('text/html'); + $r->content_type('text/html; charset=UTF-8'); } $r->send_http_header; return OK; @@ -359,9 +367,10 @@ sub end_state { package Apache::lonhelper::helper; use Digest::MD5 qw(md5_hex); -use HTML::Entities; +use HTML::Entities(); use Apache::loncommon; use Apache::File; +use Apache::lonlocal; sub new { my $proto = shift; @@ -453,11 +462,11 @@ sub _saveVars { my $self = shift; my $result = ""; $result .= '<input type="hidden" name="CURRENT_STATE" value="' . - HTML::Entities::encode($self->{STATE}) . "\" />\n"; + HTML::Entities::encode($self->{STATE},'<>&"') . "\" />\n"; $result .= '<input type="hidden" name="TOKEN" value="' . $self->{TOKEN} . "\" />\n"; $result .= '<input type="hidden" name="RETURN_PAGE" value="' . - HTML::Entities::encode($self->{RETURN_PAGE}) . "\" />\n"; + HTML::Entities::encode($self->{RETURN_PAGE},'<>&"') . "\" />\n"; return $result; } @@ -523,7 +532,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 "Next ->") { + if ($self->{STATE} ne "START" || $ENV{"form.SUBMIT"} eq &mt("Next ->")) { my $prevState = $self->{STATES}{$self->{STATE}}; $prevState->postprocess(); } @@ -574,13 +583,43 @@ sub display { } # Phase 4: Display. - my $stateTitle = $state->title(); - my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'',''); + my $stateTitle=&mt($state->title()); + my $helperTitle = &mt($self->{TITLE}); + my $bodytag = &Apache::loncommon::bodytag($helperTitle,'',''); + my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"'); + my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"'); + # FIXME: This should be parameterized, not concatenated - Jeremy + my $loncapaHelper = &mt("LON-CAPA Helper:"); $result .= <<HEADER; <html> +<script type="text/javascript" language="Javascript" > + var editbrowser; + function openbrowser(formname,elementname,only,omit) { + var url = '/res/?'; + if (editbrowser == null) { + url += 'launch=1&'; + } + url += 'catalogmode=interactive&'; + url += 'mode=parmset&'; + url += 'form=' + formname + '&'; + if (only != null) { + url += 'only=' + only + '&'; + } + if (omit != null) { + url += 'omit=' + omit + '&'; + } + url += 'element=' + elementname + ''; + var title = 'Browser'; + var options = 'scrollbars=1,resizable=1,menubar=0'; + options += ',width=700,height=600'; + editbrowser = open(url,title,options,'1'); + editbrowser.focus(); + } +</script> <head> - <title>LON-CAPA Helper: $self->{TITLE}</title> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>$loncapaHelper: $helperTitle</title> </head> $bodytag HEADER @@ -607,12 +646,12 @@ HEADER } if ($self->{DONE}) { my $returnPage = $self->{RETURN_PAGE}; - $result .= "<a href=\"$returnPage\">End Helper</a>"; + $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 .= 'value="' . $previous . '" onclick="history.go(-1)" /> '; + $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>'; } } @@ -626,12 +665,12 @@ HEADER } if ($self->{DONE}) { my $returnPage = $self->{RETURN_PAGE}; - $result .= "<a href=\"$returnPage\">End Helper</a>"; + $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 .= 'value="' . $previous . '" onclick="history.go(-1)" /> '; + $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>'; } } @@ -883,6 +922,7 @@ sub start_defaultvalue { sub end_defaultvalue { return ''; } +# Validators may need to take language specifications sub start_validator { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; @@ -952,11 +992,17 @@ within each other.) This is also a good template for creating your own new states, as it has very little code beyond the state template. +=head3 Localization + +The contents of the message tag will be run through the +normalize_string function and that will be used as a call to &mt. + =cut no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::message', @@ -998,7 +1044,7 @@ sub end_message { sub render { my $self = shift; - return $self->{MESSAGE_TEXT}; + return &mtn($self->{MESSAGE_TEXT}); } # If a NEXTSTATE was given, switch to it sub postprocess { @@ -1100,6 +1146,7 @@ tag is stored in the {VARS} hash. no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::choices', @@ -1183,10 +1230,13 @@ SCRIPT # Only print "select all" and "unselect all" if there are five or # more choices; fewer then that and it looks silly. if ($self->{'multichoice'} && scalar(@{$self->{CHOICES}}) > 4) { + my %lt=&Apache::lonlocal::texthash( + 'sa' => "Select All", + 'ua' => "Unselect All"); $buttons = <<BUTTONS; <br /> -<input type="button" onclick="checkall(true, '$var')" value="Select All" /> -<input type="button" onclick="checkall(false, '$var')" value="Unselect All" /> +<input type="button" onclick="checkall(true, '$var')" value="$lt{'sa'}" /> +<input type="button" onclick="checkall(false, '$var')" value="$lt{'ua'}" /> <br /> BUTTONS } @@ -1241,7 +1291,7 @@ BUTTONS $result .= "<tr>\n<td width='20'> </td>\n"; $result .= "<td valign='top'><input type='$type' name='$var.forminput'" . "' value='" . - HTML::Entities::encode($choice->[1]) + HTML::Entities::encode($choice->[1],'<>&"') . "'"; if ($checkedChoices{$choice->[1]}) { $result .= " checked "; @@ -1253,7 +1303,8 @@ BUTTONS $choiceLabel = eval($choiceLabel); $choiceLabel = &$choiceLabel($helper, $self); } - $result .= "/></td><td> " . $choiceLabel . "</td></tr>\n"; + &Apache::lonnet::logthis("TITLE TRANSLATION >$choiceLabel<"); + $result .= "/></td><td> " . &mtn($choiceLabel) . "</td></tr>\n"; } $result .= "</table>\n\n\n"; $result .= $buttons; @@ -1268,8 +1319,8 @@ sub postprocess { my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'}; if (!defined($chosenValue) && !$self->{'allowempty'}) { - $self->{ERROR_MSG} = "You must choose one or more choices to" . - " continue."; + $self->{ERROR_MSG} = + &mt("You must choose one or more choices to continue."); return 0; } @@ -1312,9 +1363,13 @@ the result is stored in. =cut +# This really ought to be a sibling class to "choice" which is itself +# a child of some abstract class.... *shrug* + no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::dropdown', @@ -1392,7 +1447,7 @@ sub render { $result .= "<select name='${var}.forminput'>\n"; foreach my $choice (@{$self->{CHOICES}}) { $result .= "<option value='" . - HTML::Entities::encode($choice->[1]) + HTML::Entities::encode($choice->[1],'<>&"') . "'"; if ($checkedChoices{$choice->[1]}) { $result .= " selected"; @@ -1404,7 +1459,7 @@ sub render { $choiceLabel = eval($choiceLabel); $choiceLabel = &$choiceLabel($helper, $self); } - $result .= ">" . $choiceLabel . "\n"; + $result .= ">" . &mtn($choiceLabel) . "\n"; } $result .= "</select>\n"; @@ -1473,6 +1528,7 @@ Example: no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; # A localization nightmare use Time::localtime; @@ -1537,7 +1593,7 @@ sub render { } else { $result .= "<option value='$i'>"; } - $result .= $months[$i] . "</option>\n"; + $result .= &mt($months[$i]) . "</option>\n"; } $result .= "</select>\n"; @@ -1567,25 +1623,28 @@ sub render { # Display Hours and Minutes if they are called for if ($self->{'hoursminutes'}) { + # This needs parameterization for times. + my $am = &mt('a.m.'); + my $pm = &mt('p.m.'); # Build hour $result .= "<select name='${var}hour'>\n"; $result .= "<option " . ($date->hour == 0 ? 'selected ':'') . - " value='0'>midnight</option>\n"; + " value='0'>" . &mt('midnight') . "</option>\n"; for ($i = 1; $i < 12; $i++) { if ($date->hour == $i) { - $result .= "<option selected value='$i'>$i a.m.</option>\n"; + $result .= "<option selected value='$i'>$i $am</option>\n"; } else { - $result .= "<option value='$i'>$i a.m</option>\n"; + $result .= "<option value='$i'>$i $am</option>\n"; } } $result .= "<option " . ($date->hour == 12 ? 'selected ':'') . - " value='12'>noon</option>\n"; + " value='12'>" . &mt('noon') . "</option>\n"; for ($i = 13; $i < 24; $i++) { my $printedHour = $i - 12; if ($date->hour == $i) { - $result .= "<option selected value='$i'>$printedHour p.m.</option>\n"; + $result .= "<option selected value='$i'>$printedHour $pm</option>\n"; } else { - $result .= "<option value='$i'>$printedHour p.m.</option>\n"; + $result .= "<option value='$i'>$printedHour $pm</option>\n"; } } @@ -1624,17 +1683,26 @@ sub postprocess { $hour = $ENV{'form.' . $var . 'hour'}; } - my $chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year); + my $chosenDate; + eval {$chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);}; + my $error = $@; + # Check to make sure that the date was not automatically co-erced into a # valid date, as we want to flag that as an error # This happens for "Feb. 31", for instance, which is coerced to March 2 or - # 3, depending on if it's a leapyear + # 3, depending on if it's a leap year my $checkDate = localtime($chosenDate); - if ($checkDate->mon != $month || $checkDate->mday != $day || + if ($error || $checkDate->mon != $month || $checkDate->mday != $day || $checkDate->year + 1900 != $year) { + unless (Apache::lonlocal::current_language()== ~/^en/) { + $self->{ERROR_MSG} = &mt("Invalid date entry"); + return 0; + } + # LOCALIZATION FIXME: Needs to be parameterized $self->{ERROR_MSG} = "Can't use " . $months[$month] . " $day, $year as a " . "date because it doesn't exist. Please enter a valid date."; + return 0; } @@ -1737,6 +1805,7 @@ sub start_resource { $paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'}; $paramHash->{'toponly'} = $token->[2]{'toponly'}; $paramHash->{'addstatus'} = $token->[2]{'addstatus'}; + $paramHash->{'closeallpages'} = $token->[2]{'closeallpages'}; return ''; } @@ -1852,10 +1921,14 @@ sub render { } </script> SCRIPT + my %lt=&Apache::lonlocal::texthash( + 'sar' => "Select All Resources", + 'uar' => "Unselect All Resources"); + $buttons = <<BUTTONS; <br /> -<input type="button" onclick="checkall(true, '$var')" value="Select All Resources" /> -<input type="button" onclick="checkall(false, '$var')" value="Unselect All Resources" /> +<input type="button" onclick="checkall(true, '$var')" value="$lt{'sar'}" /> +<input type="button" onclick="checkall(false, '$var')" value="$lt{'uar'}" /> <br /> BUTTONS } @@ -1905,7 +1978,7 @@ BUTTONS $checked = 1; } $col .= "value='" . - HTML::Entities::encode(&$valueFunc($resource)) + HTML::Entities::encode(&$valueFunc($resource),'<>&"') . "' /></td>"; return $col; } @@ -1922,6 +1995,7 @@ BUTTONS 'showParts' => 0, 'filterFunc' => $filterFunc, 'resource_no_folder_link' => 1, + 'closeAllPages' => $self->{'closeallpages'}, 'suppressEmptySequences' => $self->{'suppressEmptySequences'}, 'iterator_map' => $mapUrl } ); @@ -1987,7 +2061,7 @@ shown. Defaults to false. no strict; @ISA = ("Apache::lonhelper::element"); use strict; - +use Apache::lonlocal; BEGIN { @@ -2044,12 +2118,39 @@ sub render { } } } + function checksec(value) { + for (i=0; i<document.forms.helpform.elements.length; i++) { + comp = document.forms.helpform.elements.chksec.value; + if (document.forms.helpform.elements[i].value.indexOf(':'+comp+':') != -1) { + document.forms.helpform.elements[i].checked=value; + } + } + } + function checkactive() { + for (i=0; i<document.forms.helpform.elements.length; i++) { + if (document.forms.helpform.elements[i].value.indexOf(':Active') != -1) { + document.forms.helpform.elements[i].checked=true; + } + } + } </script> SCRIPT + + my %lt=&Apache::lonlocal::texthash( + 'ocs' => "Select Only Current Students", + 'sas' => "Select All Students", + 'uas' => "Unselect All Students", + 'sfsg' => "Select for Section/Group", + 'ufsg' => "Unselect for Section/Group"); + $buttons = <<BUTTONS; <br /> -<input type="button" onclick="checkall(true, '$var')" value="Select All Students" /> -<input type="button" onclick="checkall(false, '$var')" value="Unselect All Students" /> +<input type="button" onclick="checkactive()" value="$lt{'ocs'}" /> +<input type="button" onclick="checkall(true, '$var')" value="$lt{'sas'}" /> +<input type="button" onclick="checkall(false, '$var')" value="$lt{'uas'}" /> +<input type="button" onclick="checksec(true)" value="$lt{'sfsg'}"> +<input type="text" size="5" name="chksec"> +<input type="button" onclick="checksec(false)" value="$lt{'ufsg'}"> <br /> BUTTONS } @@ -2103,17 +2204,21 @@ BUTTONS if (!$self->{'activeonly'} || $classlist->{$_}->[$status] eq 'Active') { push @$choices, [$_, $classlist->{$_}->[$fullname], - $classlist->{$_}->[$section], 'Student']; + $classlist->{$_}->[$section], + $classlist->{$_}->[$status], 'Student']; } } - my $name = $self->{'coursepersonnel'} ? 'Name' : 'Student Name'; + my $name = $self->{'coursepersonnel'} ? &mt('Name') : &mt('Student Name'); + &Apache::lonnet::logthis("THE NAME IS >$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>$name</b></td>". - "<td align='center'><b>Section</b></td>" . - "<td align='center'><b>Role</b></td></tr>"; + "<td align='center'><b>" . &mt('Section') . "</b></td>" . + "<td align='center'><b>".&mt('Status')."</b></td>" . + "<td align='center'><b>" . &mt("Role") . "</b></td>" . + "<td align='center'><b>".&mt('Username').":".&mt('Domain')."</b></td></tr>"; my $checked = 0; for my $choice (@$choices) { @@ -2125,13 +2230,18 @@ BUTTONS $checked = 1; } $result .= - " value='" . HTML::Entities::encode($choice->[0] . ':' . $choice->[2]) + " value='" . HTML::Entities::encode($choice->[0] . ':' . $choice->[2] . ':' . $choice->[1] . ':' . $choice->[3],'<>&"') . "' /></td><td>" - . HTML::Entities::encode($choice->[1]) + . HTML::Entities::encode($choice->[1],'<>&"') . "</td><td align='center'>" - . HTML::Entities::encode($choice->[2]) + . HTML::Entities::encode($choice->[2],'<>&"') + . "</td>\n<td>" + . HTML::Entities::encode($choice->[3],'<>&"') . "</td>\n<td>" - . HTML::Entities::encode($choice->[3]) . "</td></tr>\n"; + . HTML::Entities::encode($choice->[4],'<>&"') + . "</td>\n<td>" + . HTML::Entities::encode($choice->[0],'<>&"') + . "</td></tr>\n"; } $result .= "</table>\n\n"; @@ -2145,8 +2255,8 @@ sub postprocess { my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'}; if (!$result) { - $self->{ERROR_MSG} = 'You must choose at least one student '. - 'to continue.'; + $self->{ERROR_MSG} = + &mt('You must choose at least one student to continue.'); return 0; } @@ -2212,6 +2322,7 @@ viewing the files. no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; use Apache::lonpubdir; # for getTitleString @@ -2330,16 +2441,22 @@ sub render { } </script> SCRIPT - $buttons = <<BUTTONS; + my %lt=&Apache::lonlocal::texthash( + 'saf' => "Select All Files", + 'uaf' => "Unselect All Files"); + $buttons = <<BUTTONS; <br /> -<input type="button" onclick="checkall(true, '$var')" value="Select All Files" /> -<input type="button" onclick="checkall(false, '$var')" value="Unselect All Files" /> +<input type="button" onclick="checkall(true, '$var')" value="$lt{'saf'}" /> +<input type="button" onclick="checkall(false, '$var')" value="$lt{'uaf'}" /> BUTTONS + my %lt=&Apache::lonlocal::texthash( + 'sap' => "Select All Published", + 'uap' => "Unselect All Published"); if ($helper->{VARS}->{'construction'}) { - $buttons .= <<BUTTONS; -<input type="button" onclick="checkallclass(true, 'Published')" value="Select All Published" /> -<input type="button" onclick="checkallclass(false, 'Published')" value="Unselect All Published" /> + $buttons .= <<BUTTONS; +<input type="button" onclick="checkallclass(true, 'Published')" value="$lt{'sap'}" /> +<input type="button" onclick="checkallclass(false, 'Published')" value="$lt{'uap'}" /> <br /> BUTTONS } @@ -2421,7 +2538,7 @@ BUTTONS } $result .= '<tr><td align="right"' . " bgcolor='$color'>" . "<input $onclick type='$type' name='" . $var - . ".forminput' value='" . HTML::Entities::encode($fileName) . + . ".forminput' value='" . HTML::Entities::encode($fileName,'<>&"'). "'"; if (!$self->{'multichoice'} && $choices == 0) { $result .= ' checked'; @@ -2830,7 +2947,7 @@ the old values taking effect. no strict; @ISA = ("Apache::lonhelper::element"); use strict; - +use Apache::lonlocal; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::final', ('final', 'exitpage')); @@ -2915,7 +3032,8 @@ sub render { } if (!@results) { - $result .= ' <li>No changes were made to current settings.</li>'; + $result .= ' <li>' . + &mt('No changes were made to current settings.') . '</li>'; } $result .= '</ul>'; @@ -2923,16 +3041,24 @@ sub render { if ($self->{'restartCourse'}) { my $targetURL = '/adm/menu'; + if ($ENV{'course.'.$ENV{'request.course.id'}.'.url'}=~/^uploaded/) { + $targetURL = '/adm/coursedocs'; + } else { + $targetURL = '/adm/navmaps'; + } if ($ENV{'course.'.$ENV{'request.course.id'}.'.clonedfrom'}) { $targetURL = '/adm/parmset?overview=1'; } + my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"'); + my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"'); $result .= "<center>\n" . "<form action='/adm/roles' method='post' target='loncapaclient'>\n" . - "<input type='button' onclick='history.go(-1)' value='<- Previous' />" . + "<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 Course Initialization' />\n" . + "' value='1' />\n<input type='submit' value='" . + &mt('Finish Course Initialization') . "' />\n" . "</form></center>"; } @@ -3035,7 +3161,7 @@ sub render { } my $result = "<form name='helpform' method='get' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n"; - $result .= '<p>Confirm that this information is correct, then click "Finish Wizard" to complete setting the parameter.<ul>'; + $result .= '<p>Confirm that this information is correct, then click "Finish Helper" to complete setting the parameter.<ul>'; # Print the type of manipulation: $result .= '<li>Setting the <b>' . $dateTypeHash{$vars->{ACTION_TYPE}} . '</b>'; @@ -3080,7 +3206,7 @@ sub render { $result .= "<li>for section <b>$section</b></li>"; $level -= 3; $result .= "<input type='hidden' name='csec' value='" . - HTML::Entities::encode($section) . "' />\n"; + HTML::Entities::encode($section,'<>&"') . "' />\n"; } else { # FIXME: This is probably wasteful! Store the name! my $classlist = Apache::loncoursedata::get_classlist(); @@ -3092,9 +3218,9 @@ sub render { $level -= 6; my ($uname, $udom) = split /:/, $vars->{USER_NAME}; $result .= "<input type='hidden' name='uname' value='". - HTML::Entities::encode($uname) . "' />\n"; + HTML::Entities::encode($uname,'<>&"') . "' />\n"; $result .= "<input type='hidden' name='udom' value='". - HTML::Entities::encode($udom) . "' />\n"; + HTML::Entities::encode($udom,'<>&"') . "' />\n"; } # Print value