--- loncom/interface/lonhelper.pm 2003/06/12 13:52:06 1.37
+++ loncom/interface/lonhelper.pm 2004/04/27 18:35:18 1.80
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# .helper XML handler to implement the LON-CAPA helper
#
-# $Id: lonhelper.pm,v 1.37 2003/06/12 13:52:06 bowersj2 Exp $
+# $Id: lonhelper.pm,v 1.80 2004/04/27 18:35:18 sakharuk Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -32,9 +32,23 @@
=pod
-=head1 lonhelper - HTML Helper framework for LON-CAPA
+=head1 NAME
-Helpers, often known as "wizards", are well-established UI widgets that users
+lonhelper - implements helper framework
+
+=head1 SYNOPSIS
+
+lonhelper implements the helper framework for LON-CAPA, and provides
+ many generally useful components for that framework.
+
+Helpers are little programs which present the user with a sequence of
+ simple choices, instead of one monolithic multi-dimensional
+ choice. They are also referred to as "wizards", "druids", and
+ other potentially trademarked or semantically-loaded words.
+
+=head1 OVERVIEWX<lonhelper>
+
+Helpers are well-established UI widgets that users
feel comfortable with. It can take a complicated multidimensional problem the
user has and turn it into a series of bite-sized one-dimensional questions.
@@ -46,7 +60,7 @@ directory and having the .helper file ex
All classes are in the Apache::lonhelper namespace.
-=head2 lonhelper XML file format
+=head1 lonhelper XML file formatX<lonhelper, XML file format>
A helper consists of a top-level <helper> tag which contains a series of states.
Each state contains one or more state elements, which are what the user sees, like
@@ -87,7 +101,7 @@ Of course this does nothing. In order fo
necessary to put actual elements into the wizard. Documentation for each
of these elements follows.
-=head2 Creating a Helper With Code, Not XML
+=head1 Creating a Helper With Code, Not XML
In some situations, such as the printing wizard (see lonprintout.pm),
writing the helper in XML would be too complicated, because of scope
@@ -146,10 +160,10 @@ Normally the machinery in the XML format
adding states can easily be done by wrapping the state in a <condition>
tag. This should only be used when the code dominates the XML content,
the code is so complicated that it is difficult to get access to
-all of the information you need because of scoping issues, or so much
-of the information used is persistent because would-be <exec> or
-<eval> blocks that using the {DATA} mechanism results in hard-to-read
-and -maintain code.
+all of the information you need because of scoping issues, or would-be <exec> or
+<eval> blocks using the {DATA} mechanism results in hard-to-read
+and -maintain code. (See course.initialization.helper for a borderline
+case.)
It is possible to do some of the work with an XML fragment parsed by
lonxml; again, see lonprintout.pm for an example. In that case it is
@@ -158,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
@@ -208,9 +230,11 @@ 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. The second was therefore never set, and was still
+# "$helper->process()" line. Using the debugger, one could actually
+# see the two different $helper variables, as hashes at completely
+# different addresses. The second was therefore never set, and was still
# undefined when I tried to call process on it.
# By pushing the "real handler" down into the "real scope", everybody except the
# actual handler function directly below this comment gets the same $helper and
@@ -239,21 +263,13 @@ sub real_handler {
# Send header, don't cache this page
- if ($r->header_only) {
- if ($ENV{'browser.mathml'}) {
- $r->content_type('text/xml');
- } else {
- $r->content_type('text/html');
- }
- $r->send_http_header;
- return OK;
- }
if ($ENV{'browser.mathml'}) {
- $r->content_type('text/xml');
+ &Apache::loncommon::content_type($r,'text/xml');
} else {
- $r->content_type('text/html');
+ &Apache::loncommon::content_type($r,'text/html');
}
$r->send_http_header;
+ return OK if $r->header_only;
$r->rflush();
# Discard result, we just want the objects that get created by the
@@ -343,9 +359,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;
@@ -437,11 +454,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;
}
@@ -507,7 +524,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();
}
@@ -558,13 +575,19 @@ 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>
<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
@@ -591,12 +614,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>';
}
}
@@ -610,12 +633,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>';
}
}
@@ -748,12 +771,12 @@ package Apache::lonhelper::element;
=pod
-=head2 Element Base Class
+=head1 Element Base Class
The Apache::lonhelper::element base class provides support for elements
and defines some generally useful tags for use in elements.
-B<finalcode tag>
+=head2 finalcode tagX<finalcode>
Each element can contain a "finalcode" tag that, when the special FINAL
helper state is used, will be executed, surrounded by "sub { my $helper = shift;"
@@ -762,7 +785,7 @@ may be an empty string. See course initi
generally intended for helpers like the course initialization helper, which consist
of several panels, each of which is performing some sort of bite-sized functionality.
-B<defaultvalue tag>
+=head2 defaultvalue tagX<defaultvalue>
Each element that accepts user input can contain a "defaultvalue" tag that,
when surrounded by "sub { my $helper = shift; my $state = shift; " and "}",
@@ -779,7 +802,19 @@ some setting accidentally.
Again, see the course initialization helper for examples.
-B<getValue method>
+=head2 validator tagX<validator>
+
+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.
+
+=head2 getValue methodX<getValue (helper elements)>
If the element stores the name of the variable in a 'variable' member, which
the provided ones all do, you can retreive the value of the variable by calling
@@ -790,7 +825,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 +890,23 @@ 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)=@_;
+
+ 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;
}
@@ -882,20 +934,21 @@ package Apache::lonhelper::message;
=pod
-=head2 Element: message
+=head1 Elements
-Message elements display the contents of their <message_text> tags, and
-transition directly to the state in the <nextstate> tag. Example:
+=head2 Element: messageX<message, helper element>
- <message>
- <nextstate>GET_NAME</nextstate>
- <message_text>This is the <b>message</b> the user will see,
- <i>HTML allowed</i>.</message_text>
+Message elements display their contents, and
+transition directly to the state in the <nextstate> attribute. Example:
+
+ <message nextstate='GET_NAME'>
+ This is the <b>message</b> the user will see,
+ <i>HTML allowed</i>.
</message>
-This will display the HTML message and transition to the <nextstate> if
+This will display the HTML message and transition to the 'nextstate' if
given. The HTML will be directly inserted into the helper, so if you don't
-want text to run together, you'll need to manually wrap the <message_text>
+want text to run together, you'll need to manually wrap the message text
in <p> tags, or whatever is appropriate for your HTML.
Message tags do not add in whitespace, so if you want it, you'll need to add
@@ -907,11 +960,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',
@@ -931,8 +990,8 @@ sub start_message {
return '';
}
- $paramHash->{MESSAGE_TEXT} = &Apache::lonxml::get_all_text('/message',
- $parser);
+ $paramHash->{MESSAGE_TEXT} = &mtn(&Apache::lonxml::get_all_text('/message',
+ $parser));
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
@@ -953,7 +1012,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 {
@@ -970,7 +1029,7 @@ package Apache::lonhelper::choices;
=pod
-=head2 Element: choices
+=head2 Element: choicesX<choices, helper element>
Choice states provide a single choice to the user as a text selection box.
A "choice" is two pieces of text, one which will be displayed to the user
@@ -988,15 +1047,15 @@ value, will allow the user to select mul
value, will allow the user to select none of the choices without raising
an error message.
-B<SUB-TAGS>
+=head3 SUB-TAGS
-<choices> can have the following subtags:
+<choices> can have the following subtags:X<choice, helper tag>
=over 4
=item * <nextstate>state_name</nextstate>: If given, this will cause the
- choice element to transition to the given state after executing. If
- this is used, do not pass nextstates to the <choice> tag.
+ choice element to transition to the given state after executing.
+ This will override the <nextstate> passed to <choices> (if any).
=item * <choice />: If the choices are static,
this element will allow you to specify them. Each choice
@@ -1005,14 +1064,15 @@ B<SUB-TAGS>
For example,
<choice computer='234-12-7312'>Bobby McDormik</choice>.
- <choice> can take a parameter "eval", which if set to
- a true value, will cause the contents of the tag to be
- evaluated as it would be in an <eval> tag; see <eval> tag
- below.
+<choice> can take a parameter "eval", which if set to
+a true value, will cause the contents of the tag to be
+evaluated as it would be in an <eval> tag; see <eval> tag
+below.
<choice> may optionally contain a 'nextstate' attribute, which
-will be the state transisitoned to if the choice is made, if
-the choice is not multichoice.
+will be the state transistioned to if the choice is made, if
+the choice is not multichoice. This will override the nextstate
+passed to the parent C<choices> tag.
=back
@@ -1037,7 +1097,7 @@ You can mix and match methods of creatin
"push" onto the choice list, rather then wiping it out. (You can even
remove choices programmatically, but that would probably be bad form.)
-B<defaultvalue support>
+=head3 defaultvalue support
Choices supports default values both in multichoice and single choice mode.
In single choice mode, have the defaultvalue tag's function return the
@@ -1054,6 +1114,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',
@@ -1100,8 +1161,8 @@ sub start_choice {
}
my $computer = $token->[2]{'computer'};
- my $human = &Apache::lonxml::get_all_text('/choice',
- $parser);
+ my $human = &mt(&Apache::lonxml::get_all_text('/choice',
+ $parser));
my $nextstate = $token->[2]{'nextstate'};
my $evalFlag = $token->[2]{'eval'};
push @{$paramHash->{CHOICES}}, [$human, $computer, $nextstate,
@@ -1114,7 +1175,6 @@ sub end_choice {
}
sub render {
- # START HERE: Replace this with correct choices code.
my $self = shift;
my $var = $self->{'variable'};
my $buttons = '';
@@ -1138,10 +1198,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
}
@@ -1196,7 +1259,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 ";
@@ -1208,7 +1271,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;
@@ -1223,8 +1287,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;
}
@@ -1247,11 +1311,161 @@ sub postprocess {
}
1;
+package Apache::lonhelper::dropdown;
+
+=pod
+
+=head2 Element: dropdownX<dropdown, helper tag>
+
+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.
+
+=head3 SUB-TAGS
+
+<choice>, which acts just as it does in the "choices" element.
+
+=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',
+ ('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 .= ">" . &mtn($choiceLabel) . "\n";
+ }
+ $result .= "</select>\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
-=head2 Element: date
+=head2 Element: dateX<date, helper element>
Date elements allow the selection of a date with a drop down list.
@@ -1282,6 +1496,7 @@ Example:
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
+use Apache::lonlocal; # A localization nightmare
use Time::localtime;
@@ -1346,7 +1561,7 @@ sub render {
} else {
$result .= "<option value='$i'>";
}
- $result .= $months[$i] . "</option>\n";
+ $result .= &mt($months[$i]) . "</option>\n";
}
$result .= "</select>\n";
@@ -1376,25 +1591,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";
}
}
@@ -1433,17 +1651,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;
}
@@ -1461,7 +1688,7 @@ package Apache::lonhelper::resource;
=pod
-=head2 Element: resource
+=head2 Element: resourceX<resource, helper element>
<resource> elements allow the user to select one or multiple resources
from the current course. You can filter out which resources they can view,
@@ -1471,20 +1698,21 @@ selections across folder openings and cl
the user can manipulate the folders.
<resource> takes the standard variable attribute to control what helper
-variable stores the results. It also takes a "multichoice" attribute,
+variable stores the results. It also takes a "multichoice"X<multichoice> attribute,
which controls whether the user can select more then one resource. The
"toponly" attribute controls whether the resource display shows just the
resources in that sequence, or recurses into all sub-sequences, defaulting
to false. The "suppressEmptySequences" attribute reflects the
suppressEmptySequences argument to the render routine, which will cause
folders that have all of their contained resources filtered out to also
-be filtered out.
+be filtered out. The 'addstatus' attribute, if true, will add the icon
+and long status display columns to the display.
-B<SUB-TAGS>
+=head3 SUB-TAGS
=over 4
-=item * <filterfunc>: If you want to filter what resources are displayed
+=item * <filterfunc>X<filterfunc>: If you want to filter what resources are displayed
to the user, use a filter func. The <filterfunc> tag should contain
Perl code that when wrapped with "sub { my $res = shift; " and "}" is
a function that returns true if the resource should be displayed,
@@ -1492,21 +1720,24 @@ B<SUB-TAGS>
(See Apache::lonnavmaps documentation for information about the
resource object.)
-=item * <choicefunc>: Same as <filterfunc>, except that controls whether
+=item * <choicefunc>X<choicefunc>: Same as <filterfunc>, except that controls whether
the given resource can be chosen. (It is almost always a good idea to
show the user the folders, for instance, but you do not always want to
let the user select them.)
=item * <nextstate>: Standard nextstate behavior.
-=item * <valuefunc>: This function controls what is returned by the resource
+=item * <valuefunc>X<valuefunc>: This function controls what is returned by the resource
when the user selects it. Like filterfunc and choicefunc, it should be
a function fragment that when wrapped by "sub { my $res = shift; " and
"}" returns a string representing what you want to have as the value. By
default, the value will be the resource ID of the object ($res->{ID}).
-=item * <mapurl>: If the URL of a map is given here, only that map
- will be displayed, instead of the whole course.
+=item * <mapurl>X<mapurl>: If the URL of a map is given here, only that map
+ will be displayed, instead of the whole course. If the attribute
+ "evaluate" is given and is true, the contents of the mapurl will be
+ evaluated with "sub { my $helper = shift; my $state = shift;" and
+ "}", with the return value used as the mapurl.
=back
@@ -1541,6 +1772,8 @@ sub start_resource {
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
$paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'};
$paramHash->{'toponly'} = $token->[2]{'toponly'};
+ $paramHash->{'addstatus'} = $token->[2]{'addstatus'};
+ $paramHash->{'closeallpages'} = $token->[2]{'closeallpages'};
return '';
}
@@ -1617,6 +1850,7 @@ sub start_mapurl {
my $contents = Apache::lonxml::get_all_text('/mapurl',
$parser);
+ $paramHash->{EVAL_MAP_URL} = $token->[2]{'evaluate'};
$paramHash->{MAP_URL} = $contents;
}
@@ -1655,10 +1889,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
}
@@ -1672,9 +1910,18 @@ BUTTONS
my $filterFunc = $self->{FILTER_FUNC};
my $choiceFunc = $self->{CHOICE_FUNC};
my $valueFunc = $self->{VALUE_FUNC};
- my $mapUrl = $self->{MAP_URL};
my $multichoice = $self->{'multichoice'};
+ # Evaluate the map url as needed
+ my $mapUrl;
+ if ($self->{EVAL_MAP_URL}) {
+ my $mapUrlFunc = eval('sub { my $helper = shift; my $state = shift; ' .
+ $self->{MAP_URL} . '}');
+ $mapUrl = &$mapUrlFunc($helper, $self);
+ } else {
+ $mapUrl = $self->{MAP_URL};
+ }
+
# Create the composite function that renders the column on the nav map
# have to admit any language that lets me do this can't be all bad
# - Jeremy (Pythonista) ;-)
@@ -1699,19 +1946,24 @@ BUTTONS
$checked = 1;
}
$col .= "value='" .
- HTML::Entities::encode(&$valueFunc($resource))
+ HTML::Entities::encode(&$valueFunc($resource),'<>&"')
. "' /></td>";
return $col;
}
};
$ENV{'form.condition'} = !$self->{'toponly'};
+ my $cols = [$renderColFunc, Apache::lonnavmaps::resource()];
+ if ($self->{'addstatus'}) {
+ push @$cols, (Apache::lonnavmaps::part_status_summary());
+
+ }
$result .=
- &Apache::lonnavmaps::render( { 'cols' => [$renderColFunc,
- Apache::lonnavmaps::resource()],
+ &Apache::lonnavmaps::render( { 'cols' => $cols,
'showParts' => 0,
'filterFunc' => $filterFunc,
'resource_no_folder_link' => 1,
+ 'closeAllPages' => $self->{'closeallpages'},
'suppressEmptySequences' => $self->{'suppressEmptySequences'},
'iterator_map' => $mapUrl }
);
@@ -1742,21 +1994,42 @@ package Apache::lonhelper::student;
=pod
-=head2 Element: student
+=head2 Element: studentX<student, helper element>
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 the following attributes:
+
+=over 4
+
+=item * B<variable>:
+
+Does what it usually does: declare which helper variable to put the
+result in.
+
+=item * B<multichoice>:
+
+If true allows the user to select multiple students. Defaults to false.
+
+=item * B<coursepersonnel>:
+
+If true adds the course personnel to the top of the student
+selection. Defaults to false.
+
+=item * B<activeonly>:
+
+If true, only active students and course personnel will be
+shown. Defaults to false.
+
+=back
=cut
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
-
+use Apache::lonlocal;
BEGIN {
@@ -1779,6 +2052,8 @@ sub start_student {
$paramHash->{'variable'} = $token->[2]{'variable'};
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
+ $paramHash->{'sctiveonly'} = $token->[2]{'activeonly'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
@@ -1811,12 +2086,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
}
@@ -1825,30 +2127,69 @@ 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();
+ my $status = Apache::loncoursedata::CL_STATUS();
+ # 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) {
+ # Filter out inactive students if we've set "activeonly"
+ if (!$self->{'activeonly'} || $classlist->{$_}->[$status] eq
+ 'Active') {
+ push @$choices, [$_, $classlist->{$_}->[$fullname],
+ $classlist->{$_}->[$section],
+ $classlist->{$_}->[$status], 'Student'];
+ }
+ }
+
+ 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>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>" . &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;
- foreach (@keys) {
+ for my $choice (@$choices) {
$result .= "<tr><td><input type='$type' name='" .
$self->{'variable'} . '.forminput' . "'";
@@ -1857,12 +2198,18 @@ BUTTONS
$checked = 1;
}
$result .=
- " value='" . HTML::Entities::encode($_ . ':' . $choices->{$_}->[$section])
+ " value='" . HTML::Entities::encode($choice->[0] . ':' . $choice->[2] . ':' . $choice->[1] . ':' . $choice->[3],'<>&"')
. "' /></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>\n<td>"
+ . HTML::Entities::encode($choice->[4],'<>&"')
+ . "</td>\n<td>"
+ . HTML::Entities::encode($choice->[0],'<>&"')
+ . "</td></tr>\n";
}
$result .= "</table>\n\n";
@@ -1876,8 +2223,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;
}
@@ -1894,7 +2241,7 @@ package Apache::lonhelper::files;
=pod
-=head2 Element: files
+=head2 Element: filesX<files, helper element>
files allows the users to choose files from a given directory on the
server. It is always multichoice and stores the result as a triple-pipe
@@ -1910,21 +2257,40 @@ are put. It accepts the attribute "multi
defaulting to false, which if true will allow the user to select more
then one choice.
-<files> accepts three subtags. One is the "nextstate" sub-tag that works
-as it does with the other tags. Another is a <filechoice> sub tag that
-is Perl code that, when surrounded by "sub {" and "}" will return a
-string representing what directory on the server to allow the user to
-choose files from. Finally, the <filefilter> subtag should contain Perl
-code that when surrounded by "sub { my $filename = shift; " and "}",
-returns a true value if the user can pick that file, or false otherwise.
-The filename passed to the function will be just the name of the file,
-with no path info.
+<files> accepts three subtags:
+
+=over 4
+
+=item * B<nextstate>: works as it does with the other tags.
+
+=item * B<filechoice>: When the contents of this tag are surrounded by
+ "sub {" and "}", will return a string representing what directory
+ on the server to allow the user to choose files from.
+
+=item * B<filefilter>: Should contain Perl code that when surrounded
+ by "sub { my $filename = shift; " and "}", returns a true value if
+ the user can pick that file, or false otherwise. The filename
+ passed to the function will be just the name of the file, with no
+ path info. By default, a filter function will be used that will
+ mask out old versions of files. This function is available as
+ Apache::lonhelper::files::not_old_version if you want to use it to
+ composite your own filters.
+
+=back
+
+B<General security note>: You should ensure the user can not somehow
+pass something into your code that would allow them to look places
+they should not be able to see, like the C</etc/> directory. However,
+the security impact would be minimal, since it would only expose
+the existence of files, there should be no way to parlay that into
+viewing the files.
=cut
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
+use Apache::lonlocal;
use Apache::lonpubdir; # for getTitleString
@@ -1933,6 +2299,18 @@ BEGIN {
('files', 'filechoice', 'filefilter'));
}
+sub not_old_version {
+ my $file = shift;
+
+ # Given a file name, return false if it is an "old version" of a
+ # file, or true if it is not.
+
+ if ($file =~ /^.*\.[0-9]+\.[A-Za-z]+(\.meta)?$/) {
+ return 0;
+ }
+ return 1;
+}
+
sub new {
my $ref = Apache::lonhelper::element->new();
bless($ref);
@@ -2000,6 +2378,9 @@ sub render {
my $subdir = &$subdirFunc();
my $filterFunc = $self->{FILTER_FUNC};
+ if (!defined($filterFunc)) {
+ $filterFunc = ¬_old_version;
+ }
my $buttons = '';
my $type = 'radio';
if ($self->{'multichoice'}) {
@@ -2028,16 +2409,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
+ %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
}
@@ -2047,15 +2434,26 @@ BUTTONS
my @fileList;
# If the subdirectory is in local CSTR space
- if ($subdir =~ m|/home/([^/]+)/public_html|) {
+ my $metadir;
+ if ($subdir =~ m|/home/([^/]+)/public_html/(.*)|) {
my $user = $1;
my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
+ $metadir='/res/'.$domain.'/'.$user.'/'.$2;
+ @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
+ } elsif ($subdir =~ m|^~([^/]+)/(.*)$|) {
+ $subdir='/home/'.$1.'/public_html/'.$2;
+ my $user = $1;
+ my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
+ $metadir='/res/'.$domain.'/'.$user.'/'.$2;
@fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
} else {
# local library server resource space
@fileList = &Apache::lonnet::dirlist($subdir, $ENV{'user.domain'}, $ENV{'user.name'}, '');
}
+ # Sort the fileList into order
+ @fileList = sort @fileList;
+
$result .= $buttons;
if (defined $self->{ERROR_MSG}) {
@@ -2085,7 +2483,7 @@ BUTTONS
}
# Get the title
- my $title = Apache::lonpubdir::getTitleString($fileName);
+ my $title = Apache::lonpubdir::getTitleString(($metadir?$metadir:$subdir) .'/'. $file);
# Netscape 4 is stupid and there's nowhere to put the
# information on the input tag that the file is Published,
@@ -2108,7 +2506,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';
@@ -2123,7 +2521,7 @@ BUTTONS
$result .= "</table>\n";
if (!$choices) {
- $result .= '<font color="#FF0000">There are no files available to select in this directory. Please go back and select another option.</font><br /><br />';
+ $result .= '<font color="#FF0000">There are no files available to select in this directory ('.$subdir.'). Please go back and select another option.</font><br /><br />';
}
$result .= $buttons;
@@ -2184,7 +2582,7 @@ package Apache::lonhelper::section;
=pod
-=head2 Element: section
+=head2 Element: sectionX<section, helper element>
<section> allows the user to choose one or more sections from the current
course.
@@ -2258,7 +2656,7 @@ package Apache::lonhelper::string;
=pod
-=head2 Element: string
+=head2 Element: stringX<string, helper element>
string elements provide a string entry field for the user. string elements
take the usual 'variable' and 'nextstate' parameters. string elements
@@ -2266,11 +2664,14 @@ also pass through 'maxlength' and 'size'
string honors the defaultvalue tag, if given.
+string honors the validation function, if given.
+
=cut
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
+use Apache::lonlocal;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::string',
@@ -2311,7 +2712,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'} . '"';
@@ -2335,8 +2742,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;
@@ -2348,9 +2766,9 @@ package Apache::lonhelper::general;
=pod
-=head2 General-purpose tag: <exec>
+=head2 General-purpose tag: <exec>X<exec, helper tag>
-The contents of the exec tag are executed as Perl code, not inside a
+The contents of the exec tag are executed as Perl code, B<not> inside a
safe space, so the full range of $ENV and such is available. The code
will be executed as a subroutine wrapped with the following code:
@@ -2363,7 +2781,7 @@ The return value is ignored.
$helper is the helper object. Feel free to add methods to the helper
object to support whatever manipulation you may need to do (for instance,
overriding the form location if the state is the final state; see
-lonparm.helper for an example).
+parameter.helper for an example).
$state is the $paramHash that has currently been generated and may
be manipulated by the code in exec. Note that the $state is not yet
@@ -2438,7 +2856,7 @@ sub end_clause { return ''; }
=pod
-=head2 General-purpose tag: <eval>
+=head2 General-purpose tag: <eval>X<eval, helper tag>
The <eval> tag will be evaluated as a subroutine call passed in the
current helper object and state hash as described in <condition> above,
@@ -2481,10 +2899,10 @@ package Apache::lonhelper::final;
=pod
-=head2 Element: final
+=head2 Element: finalX<final, helper tag>
<final> is a special element that works with helpers that use the <finalcode>
-tag. It goes through all the states and elements, executing the <finalcode>
+tagX<finalcode, helper tag>. It goes through all the states and elements, executing the <finalcode>
snippets and collecting the results. Finally, it takes the user out of the
helper, going to a provided page.
@@ -2498,7 +2916,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'));
@@ -2574,31 +2992,46 @@ 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>' .
+ &mt('No changes were made to current settings.') . '</li>';
+ }
+
+ $result .= '</ul>';
}
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='hidden' name='orgurl' value='/adm/menu' />" .
+ "<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>";
}
- return $result . '</ul>';
+ return $result;
}
sub overrideForm {
@@ -2618,6 +3051,7 @@ package Apache::lonhelper::parmwizfinal;
no strict;
@ISA = ('Apache::lonhelper::element');
use strict;
+use Apache::lonlocal;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::parmwizfinal',
@@ -2648,12 +3082,17 @@ sub render {
my $vars = $helper->{VARS};
# FIXME: Unify my designators with the standard ones
- my %dateTypeHash = ('open_date' => "Opening Date",
- 'due_date' => "Due Date",
- 'answer_date' => "Answer Date");
+ my %dateTypeHash = ('open_date' => "opening date",
+ 'due_date' => "due date",
+ 'answer_date' => "answer date",
+ 'tries' => 'number of tries',
+ 'weight' => 'problem weight'
+ );
my %parmTypeHash = ('open_date' => "0_opendate",
'due_date' => "0_duedate",
- 'answer_date' => "0_answerdate");
+ 'answer_date' => "0_answerdate",
+ 'tries' => '0_maxtries',
+ 'weight' => '0_weight' );
my $affectedResourceId = "";
my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}};
@@ -2664,43 +3103,52 @@ sub render {
# Print the granularity, depending on the action
if ($vars->{GRANULARITY} eq 'whole_course') {
- $resourceString .= '<li>for <b>all resources in the course</b></li>';
+ $resourceString .= '<li>'.&mt('for <b>all resources in the course</b>').'</li>';
$level = 9; # general course, see lonparmset.pm perldoc
$affectedResourceId = "0.0";
$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 $navmap = Apache::lonnavmaps::navmap->new();
my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
my $title = $res->compTitle();
$symb = $res->symb();
$navmap->untieHashes();
- $resourceString .= "<li>for the map named <b>$title</b></li>";
+ $resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
$level = 8;
$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();
$navmap->untieHashes();
- $resourceString .= "<li>for the resource named <b>$title</b></li>";
+ $resourceString .= '<li>'.&mt('for the resource named [_1]',"<b>$title</b>").'</li>';
$level = 7;
$affectedResourceId = $vars->{RESOURCE_ID};
$paramlevel = 'full';
}
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>'.&mt('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></li>\n";
+ my $extra;
+ if ($vars->{ACTION_TYPE} eq 'tries') {
+ $extra = $vars->{TRIES};
+ }
+ if ($vars->{ACTION_TYPE} eq 'weight') {
+ $extra = $vars->{WEIGHT};
+ }
+ $result .= "<li>";
+ my $what = &mt($dateTypeHash{$vars->{ACTION_TYPE}});
+ if ($extra) {
+ $result .= &mt('Setting the [_1] to [_2]',"<b>$what</b>",$extra);
+ } else {
+ $result .= &mt('Setting the [_1]',"<b>$what</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
@@ -2717,19 +3165,25 @@ 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";
+ } elsif ($vars->{ACTION_TYPE} eq 'weight') {
+ $result .= "<input type='hidden' name='pres_value' " .
+ "value='" . $vars->{WEIGHT} . "' />\n";
+ }
$result .= $resourceString;
# Print targets
if ($vars->{TARGETS} eq 'course') {
- $result .= '<li>for <b>all students in course</b></li>';
+ $result .= '<li>'.&mt('for <b>all students in course</b>').'</li>';
} elsif ($vars->{TARGETS} eq 'section') {
my $section = $vars->{SECTION_NAME};
- $result .= "<li>for section <b>$section</b></li>";
+ $result .= '<li>'.&mt('for section [_1]',"<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();
@@ -2737,20 +3191,20 @@ sub render {
# Chop off everything after the last colon (section)
$username = substr($username, 0, rindex($username, ':'));
my $name = $classlist->{$username}->[6];
- $result .= "<li>for <b>$name</b></li>";
+ $result .= '<li>'.&mt('for [_1]',"<b>$name</b>").'</li>';
$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
- $result .= "<li>to <b>" . ctime($vars->{PARM_DATE}) . "</b> (" .
- Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE})
- . ")</li>\n";
-
+ if ($vars->{ACTION_TYPE} ne 'tries' && $vars->{ACTION_TYPE} ne 'weight') {
+ $result .= '<li>'.&mt('to [_1] ( [_2] )',"<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";
@@ -2761,7 +3215,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='Finish Helper' /></center></form>\n";
+ $result .= "<br /><br /><center><input type='submit' value='".&mt('Finish Helper')."' /></center></form>\n";
return $result;
}