--- loncom/interface/lonhelper.pm 2003/09/29 16:33:09 1.48
+++ loncom/interface/lonhelper.pm 2008/12/19 20:51:35 1.169
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# .helper XML handler to implement the LON-CAPA helper
#
-# $Id: lonhelper.pm,v 1.48 2003/09/29 16:33:09 bowersj2 Exp $
+# $Id: lonhelper.pm,v 1.169 2008/12/19 20:51:35 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,10 +25,6 @@
#
# http://www.lon-capa.org/
#
-# (Page Handler
-#
-# (.helper handler
-#
=pod
@@ -85,25 +81,28 @@ State tags are also required to have an
human name of the state, and will be displayed as the header on top of
the screen for the user.
+State tags may also optionally have an attribute "help" which should be
+the filename of a help file, this will add a blue ? to the title.
+
=head2 Example Helper Skeleton
An example of the tags so far:
<helper title="Example Helper">
<state name="START" title="Demonstrating the Example Helper">
- <!-- notice this is the START state the wizard requires -->
+ <!-- notice this is the START state the helper requires -->
</state>
<state name="GET_NAME" title="Enter Student Name">
</state>
</helper>
-Of course this does nothing. In order for the wizard to do something, it is
-necessary to put actual elements into the wizard. Documentation for each
+Of course this does nothing. In order for the helper to do something, it is
+necessary to put actual elements into the helper. Documentation for each
of these elements follows.
=head1 Creating a Helper With Code, Not XML
-In some situations, such as the printing wizard (see lonprintout.pm),
+In some situations, such as the printing helper (see lonprintout.pm),
writing the helper in XML would be too complicated, because of scope
issues or the fact that the code actually outweighs the XML. It is
possible to create a helper via code, though it is a little odd.
@@ -172,12 +171,24 @@ 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;
+use Apache::lonnet;
+use Apache::longroup;
+use Apache::lonselstudent;
+use LONCAPA;
# Register all the tags with the helper, so the helper can
# push and pop them
@@ -222,7 +233,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
@@ -247,7 +258,7 @@ sub real_handler {
my $r = shift;
my $uri = shift;
if (!defined($uri)) { $uri = $r->uri(); }
- $ENV{'request.uri'} = $uri;
+ $env{'request.uri'} = $uri;
my $filename = '/home/httpd/html' . $uri;
my $fh = Apache::File->new($filename);
my $file;
@@ -255,21 +266,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');
+ if ($env{'browser.mathml'}) {
+ &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
@@ -278,7 +281,7 @@ sub real_handler {
my $allowed = $helper->allowedCheck();
if (!$allowed) {
- $ENV{'user.error.msg'} = $ENV{'request.uri'}.':'.$helper->{REQUIRED_PRIV}.
+ $env{'user.error.msg'} = $env{'request.uri'}.':'.$helper->{REQUIRED_PRIV}.
":0:0:Permission denied to access this helper.";
return HTTP_NOT_ACCEPTABLE;
}
@@ -334,7 +337,8 @@ sub start_state {
}
Apache::lonhelper::state->new($token->[2]{'name'},
- $token->[2]{'title'});
+ $token->[2]{'title'},
+ $token->[2]{'help'});
return '';
}
@@ -359,9 +363,12 @@ 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;
+use Apache::lonnet;
+use LONCAPA;
sub new {
my $proto = shift;
@@ -373,16 +380,16 @@ sub new {
# If there is a state from the previous form, use that. If there is no
# state, use the start state parameter.
- if (defined $ENV{"form.CURRENT_STATE"})
+ if (defined $env{"form.CURRENT_STATE"})
{
- $self->{STATE} = $ENV{"form.CURRENT_STATE"};
+ $self->{STATE} = $env{"form.CURRENT_STATE"};
}
else
{
$self->{STATE} = "START";
}
- $self->{TOKEN} = $ENV{'form.TOKEN'};
+ $self->{TOKEN} = $env{'form.TOKEN'};
# If a token was passed, we load that in. Otherwise, we need to create a
# new storage file
# Tried to use standard Tie'd hashes, but you can't seem to take a
@@ -415,16 +422,16 @@ sub new {
return undef;
}
# Must create the storage
- $self->{TOKEN} = md5_hex($ENV{'user.name'} . $ENV{'user.domain'} .
+ $self->{TOKEN} = md5_hex($env{'user.name'} . $env{'user.domain'} .
time() . rand());
$self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN});
}
# OK, we now have our persistent storage.
- if (defined $ENV{"form.RETURN_PAGE"})
+ if (defined $env{"form.RETURN_PAGE"})
{
- $self->{RETURN_PAGE} = $ENV{"form.RETURN_PAGE"};
+ $self->{RETURN_PAGE} = $env{"form.RETURN_PAGE"};
}
else
{
@@ -453,11 +460,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;
}
@@ -467,9 +474,8 @@ sub _saveVars {
sub _varsInFile {
my $self = shift;
my @vars = ();
- for my $key (keys %{$self->{VARS}}) {
- push @vars, &Apache::lonnet::escape($key) . '=' .
- &Apache::lonnet::escape($self->{VARS}->{$key});
+ for my $key (keys(%{$self->{VARS}})) {
+ push(@vars, &escape($key) . '=' . &escape($self->{VARS}->{$key}));
}
return join ('&', @vars);
}
@@ -484,12 +490,12 @@ sub declareVar {
$self->{VARS}->{$var} = '';
}
- my $envname = 'form.' . $var . '.forminput';
- if (defined($ENV{$envname})) {
- if (ref($ENV{$envname})) {
- $self->{VARS}->{$var} = join('|||', @{$ENV{$envname}});
+ my $envname = 'form.' . $var . '_forminput';
+ if (defined($env{$envname})) {
+ if (ref($env{$envname})) {
+ $self->{VARS}->{$var} = join('|||', @{$env{$envname}});
} else {
- $self->{VARS}->{$var} = $ENV{$envname};
+ $self->{VARS}->{$var} = $env{$envname};
}
}
}
@@ -501,7 +507,7 @@ sub allowedCheck {
return 1;
}
- return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $ENV{'request.course.id'});
+ return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $env{'request.course.id'});
}
sub changeState {
@@ -523,7 +529,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,20 +580,28 @@ sub display {
}
# Phase 4: Display.
- my $stateTitle = $state->title();
- my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'','');
+ my $stateTitle=&mt($state->title());
+ my $stateHelp= $state->help();
+ my $browser_searcher_js =
+ '<script type="text/javascript">'."\n".
+ &Apache::loncommon::browser_and_searcher_javascript().
+ "\n".'</script>';
+
+ $result .= &Apache::loncommon::start_page($self->{TITLE},
+ $browser_searcher_js);
+
+ my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
+ my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
+ # FIXME: This should be parameterized, not concatenated - Jeremy
+
- $result .= <<HEADER;
-<html>
- <head>
- <title>LON-CAPA Helper: $self->{TITLE}</title>
- </head>
- $bodytag
-HEADER
if (!$state->overrideForm()) { $result.="<form name='helpform' method='POST'>"; }
+ if ($stateHelp) {
+ $stateHelp = &Apache::loncommon::help_open_topic($stateHelp);
+ }
$result .= <<HEADER;
<table border="0" width='100%'><tr><td>
- <h2><i>$stateTitle</i></h2>
+ <h2><i>$stateTitle</i>$stateHelp</h2>
HEADER
$result .= "<table cellpadding='10' width='100%'><tr><td rowspan='2' valign='top'>";
@@ -607,12 +621,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 .= '<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>';
}
}
@@ -626,12 +640,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 .= '<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>';
}
}
@@ -646,10 +660,9 @@ HEADER
</tr>
</table>
</form>
- </body>
-</html>
FOOTER
+ $result .= &Apache::loncommon::end_page();
# Handle writing out the vars to the file
my $file = Apache::File->new('>'.$self->{FILENAME});
print $file $self->_varsInFile();
@@ -675,6 +688,7 @@ sub new {
$self->{NAME} = shift;
$self->{TITLE} = shift;
+ $self->{HELP} = shift;
$self->{ELEMENTS} = [];
bless($self, $class);
@@ -696,6 +710,11 @@ sub title {
return $self->{TITLE};
}
+sub help {
+ my $self = shift;
+ return $self->{HELP};
+}
+
sub preprocess {
my $self = shift;
for my $element (@{$self->{ELEMENTS}}) {
@@ -787,7 +806,7 @@ the element. How this value is interpret
the element itself, and possibly the settings the element has (such as
multichoice vs. single choice for <choices> tags).
-This is also intended for things like the course initialization wizard, where the
+This is also intended for things like the course initialization helper, where the
user is setting various parameters. By correctly grabbing current settings
and including them into the helper, it allows the user to come back to the
helper later and re-execute it, without needing to worry about overwriting
@@ -883,6 +902,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 +972,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',
@@ -976,12 +1002,15 @@ 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'};
}
+ if (defined($token->[2]{'type'})) {
+ $paramHash->{TYPE} = $token->[2]{'type'};
+ }
return '';
}
@@ -997,7 +1026,15 @@ sub end_message {
sub render {
my $self = shift;
-
+
+ if ($self->{TYPE} =~ /^\s*warning\s*$/i) {
+ $self->{MESSAGE_TEXT} =
+ '<span class="LC_warning">'. $self->{MESSAGE_TEXT}.'</span>';
+ }
+ if ($self->{TYPE} =~ /^\s*error\s*$/i) {
+ $self->{MESSAGE_TEXT} =
+ '<span class="LC_error">'. $self->{MESSAGE_TEXT}.'</span>';
+ }
return $self->{MESSAGE_TEXT};
}
# If a NEXTSTATE was given, switch to it
@@ -1011,6 +1048,175 @@ sub postprocess {
}
1;
+package Apache::lonhelper::helpicon;
+
+=pod
+
+=head1 Elements
+
+=head2 Element: helpiconX<helpicon, helper element>
+
+Helpicon elements add a help icon at the current location.
+Example:
+
+ <helpicon file="Help">
+ General Help
+ </helpicon>
+
+In this example will generate a help icon to the Help.hlp url with a
+description of 'General Help'. The description is not required and if
+left out (Example: <helpicon file="Help" /> only the icon will be
+added.)
+
+=head3 Localization
+
+The description text 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::helpicon',
+ ('helpicon'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::element->new();
+ bless($ref);
+}
+
+# CONSTRUCTION: Construct the message element from the XML
+sub start_helpicon {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{HELP_TEXT} = &mtn(&Apache::lonxml::get_all_text('/helpicon',
+ $parser));
+
+ $paramHash->{HELP_TEXT} =~s/^\s+//;
+ $paramHash->{HELP_TEXT} =~s/\s+$//;
+
+ if (defined($token->[2]{'file'})) {
+ $paramHash->{HELP_FILE} = $token->[2]{'file'};
+ }
+ return '';
+}
+
+sub end_helpicon {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ Apache::lonhelper::helpicon->new();
+ return '';
+}
+
+sub render {
+ my $self = shift;
+
+ my $text;
+ if ( $self->{HELP_TEXT} ne '') {
+ $text=&mtn($self->{HELP_TEXT});
+ }
+
+ return &Apache::loncommon::help_open_topic($self->{HELP_FILE},
+ $text);
+}
+sub postprocess {
+ my $self = shift;
+ if (defined($self->{NEXTSTATE})) {
+ $helper->changeState($self->{NEXTSTATE});
+ }
+
+ return 1;
+}
+
+1;
+
+package Apache::lonhelper::skip;
+
+=pod
+
+=head1 Elements
+
+=head2 Element: skipX<skip>
+
+The <skip> tag allows you define conditions under which the current state
+should be skipped over and define what state to skip to.
+
+ <state name="SKIP">
+ <skip>
+ <clause>
+ #some code that decides whether to skip the state or not
+ </clause>
+ <nextstate>FINISH</nextstate>
+ </skip>
+ <message nextstate="FINISH">A possibly skipped state</message>
+ </state>
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+
+BEGIN {
+ &Apache::lonhelper::register('Apache::lonhelper::skip',
+ ('skip'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::element->new();
+ bless($ref);
+}
+
+sub start_skip {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ # let <cluase> know what text to skip to
+ $paramHash->{SKIPTAG}='/skip';
+ return '';
+}
+
+sub end_skip {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ Apache::lonhelper::skip->new();
+ return '';
+}
+
+sub render {
+ my $self = shift;
+ return '';
+}
+# If a NEXTSTATE is set, switch to it
+sub preprocess {
+ my ($self) = @_;
+
+ if (defined($self->{NEXTSTATE})) {
+ $helper->changeState($self->{NEXTSTATE});
+ }
+
+ return 1;
+}
+
+1;
+
package Apache::lonhelper::choices;
=pod
@@ -1060,6 +1266,16 @@ will be the state transistioned to if th
the choice is not multichoice. This will override the nextstate
passed to the parent C<choices> tag.
+<choice> may optionally contain a 'relatedvalue' attribute, which
+if present will cause a text entry to appear to the right of the
+selection. The value of the relatedvalue attribute is a variable
+into which the text entry will be stored e.g.:
+<choice computer='numberprovided" relatedvalue="num">Type the number in:</choice>
+
+<choice> may contain a relatededefault atribute which, if the
+relatedvalue attribute is present will be the initial value of the input
+box.
+
=back
To create the choices programmatically, either wrap the choices in
@@ -1100,6 +1316,8 @@ tag is stored in the {VARS} hash.
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
+use Apache::lonlocal;
+use Apache::lonnet;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::choices',
@@ -1146,12 +1364,14 @@ sub start_choice {
}
my $computer = $token->[2]{'computer'};
- my $human = &Apache::lonxml::get_all_text('/choice',
- $parser);
- my $nextstate = $token->[2]{'nextstate'};
- my $evalFlag = $token->[2]{'eval'};
- push @{$paramHash->{CHOICES}}, [$human, $computer, $nextstate,
- $evalFlag];
+ my $human = &mt(&Apache::lonxml::get_all_text('/choice',
+ $parser));
+ my $nextstate = $token->[2]{'nextstate'};
+ my $evalFlag = $token->[2]{'eval'};
+ my $relatedVar = $token->[2]{'relatedvalue'};
+ my $relatedDefault = $token->[2]{'relateddefault'};
+ push @{$paramHash->{CHOICES}}, [&mtn($human), $computer, $nextstate,
+ $evalFlag, $relatedVar, $relatedDefault];
return '';
}
@@ -1159,6 +1379,13 @@ sub end_choice {
return '';
}
+{
+ # used to generate unique id attributes for <input> tags.
+ # internal use only.
+ my $id = 0;
+ sub new_id { return $id++; }
+}
+
sub render {
my $self = shift;
my $var = $self->{'variable'};
@@ -1167,15 +1394,17 @@ sub render {
if ($self->{'multichoice'}) {
$result .= <<SCRIPT;
-<script>
+<script type="text/javascript">
+// <!--
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
+ if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
}
+// -->
</script>
SCRIPT
}
@@ -1183,10 +1412,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
}
@@ -1238,22 +1470,31 @@ BUTTONS
my $type = "radio";
if ($self->{'multichoice'}) { $type = 'checkbox'; }
foreach my $choice (@{$self->{CHOICES}}) {
+ my $id = &new_id();
$result .= "<tr>\n<td width='20'> </td>\n";
- $result .= "<td valign='top'><input type='$type' name='$var.forminput'"
- . "' value='" .
- HTML::Entities::encode($choice->[1])
+ $result .= "<td valign='top'><input type='$type' name='${var}_forminput'"
+ . " value='" .
+ HTML::Entities::encode($choice->[1],"<>&\"'")
. "'";
if ($checkedChoices{$choice->[1]}) {
- $result .= " checked ";
+ $result .= " checked='checked' ";
}
+ $result .= qq{id="id$id"};
my $choiceLabel = $choice->[0];
- if ($choice->[4]) { # if we need to evaluate this choice
+ if ($choice->[3]) { # if we need to evaluate this choice
$choiceLabel = "sub { my $helper = shift; my $state = shift;" .
$choiceLabel . "}";
$choiceLabel = eval($choiceLabel);
$choiceLabel = &$choiceLabel($helper, $self);
}
- $result .= "/></td><td> " . $choiceLabel . "</td></tr>\n";
+ $result .= "/></td><td> ".qq{<label for="id$id">}.
+ $choiceLabel. "</label></td>";
+ if ($choice->[4]) {
+ $result .='<td><input type="text" size="5" name="'
+ .$choice->[4].'_forminput" value="'
+ .$choice->[5].'" /></td>';
+ }
+ $result .= "</tr>\n";
}
$result .= "</table>\n\n\n";
$result .= $buttons;
@@ -1265,11 +1506,11 @@ BUTTONS
# given, switch to it
sub postprocess {
my $self = shift;
- my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'};
+ 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;
}
@@ -1287,6 +1528,10 @@ sub postprocess {
$helper->changeState($choice->[2]);
}
}
+ if ($choice->[4]) {
+ my $varname = $choice->[4];
+ $helper->{'VARS'}->{$varname} = $env{'form.'."${varname}_forminput"};
+ }
}
return 1;
}
@@ -1312,9 +1557,14 @@ 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;
+use Apache::lonnet;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::dropdown',
@@ -1389,13 +1639,13 @@ sub render {
$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
}
- $result .= "<select name='${var}.forminput'>\n";
+ $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";
+ $result .= " selected='selected' ";
}
my $choiceLabel = $choice->[0];
if ($choice->[4]) { # if we need to evaluate this choice
@@ -1404,7 +1654,7 @@ sub render {
$choiceLabel = eval($choiceLabel);
$choiceLabel = &$choiceLabel($helper, $self);
}
- $result .= ">" . $choiceLabel . "\n";
+ $result .= ">" . &mtn($choiceLabel) . "</option>\n";
}
$result .= "</select>\n";
@@ -1415,7 +1665,7 @@ sub render {
# given, switch to it
sub postprocess {
my $self = shift;
- my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'};
+ my $chosenValue = $env{'form.' . $self->{'variable'} . '_forminput'};
if (!defined($chosenValue) && !$self->{'allowempty'}) {
$self->{ERROR_MSG} = "You must choose one or more choices to" .
@@ -1473,8 +1723,9 @@ Example:
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
-
-use Time::localtime;
+use Apache::lonlocal; # A localization nightmare
+use Apache::lonnet;
+use DateTime;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::date',
@@ -1501,6 +1752,7 @@ sub start_date {
$paramHash->{'variable'} = $token->[2]{'variable'};
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'hoursminutes'} = $token->[2]{'hoursminutes'};
+ $paramHash->{'anytime'} = $token->[2]{'anytime'};
}
sub end_date {
@@ -1519,10 +1771,42 @@ sub render {
my $var = $self->{'variable'};
my $date;
-
+
+ my $time=time;
+ my ($anytime,$onclick);
+
+ # first check VARS for a valid new value from the user
+ # then check DEFAULT_VALUE for a valid default time value
+ # otherwise pick now as reasonably good time
+
+ if (defined($helper->{VARS}{$var})
+ && $helper->{VARS}{$var} > 0) {
+ $date = &get_date_object($helper->{VARS}{$var});
+ } elsif (defined($self->{DEFAULT_VALUE})) {
+ my $valueFunc = eval($self->{DEFAULT_VALUE});
+ die('Error in default value code for variable ' .
+ $self->{'variable'} . ', Perl said: ' . $@) if $@;
+ $time = &$valueFunc($helper, $self);
+ if (lc($time) eq 'anytime') {
+ $anytime=1;
+ $date = &get_date_object(time);
+ $date->min(0);
+ } elsif (defined($time) && $time ne 0) {
+ $date = &get_date_object($time);
+ } else {
+ # leave date undefined so it'll default to now
+ }
+ }
+
+ if (!defined($date)) {
+ $date = &get_date_object(time);
+ $date->min(0);
+ }
+
+ if ($anytime) {
+ $onclick = "onclick=\"javascript:updateCheck(this.form,'${var}anytime',false)\"";
+ }
# Default date: The current hour.
- $date = localtime();
- $date->min(0);
if (defined $self->{ERROR_MSG}) {
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
@@ -1530,22 +1814,22 @@ sub render {
# Month
my $i;
- $result .= "<select name='${var}month'>\n";
+ $result .= "<select $onclick name='${var}month'>\n";
for ($i = 0; $i < 12; $i++) {
- if ($i == $date->mon) {
- $result .= "<option value='$i' selected>";
+ if (($i + 1) == $date->mon) {
+ $result .= "<option value='$i' selected='selected'>";
} else {
$result .= "<option value='$i'>";
}
- $result .= $months[$i] . "</option>\n";
+ $result .= &mt($months[$i])."</option>\n";
}
$result .= "</select>\n";
# Day
- $result .= "<select name='${var}day'>\n";
+ $result .= "<select $onclick name='${var}day'>\n";
for ($i = 1; $i < 32; $i++) {
if ($i == $date->mday) {
- $result .= '<option selected>';
+ $result .= '<option selected="selected">';
} else {
$result .= '<option>';
}
@@ -1554,10 +1838,10 @@ sub render {
$result .= "</select>,\n";
# Year
- $result .= "<select name='${var}year'>\n";
+ $result .= "<select $onclick name='${var}year'>\n";
for ($i = 2000; $i < 2030; $i++) { # update this after 64-bit dates
- if ($date->year + 1900 == $i) {
- $result .= "<option selected>";
+ if ($date->year == $i) {
+ $result .= "<option selected='selected'>";
} else {
$result .= "<option>";
}
@@ -1567,38 +1851,43 @@ 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";
+ $result .= "<select $onclick name='${var}hour'>\n";
+ $result .= "<option " . ($date->hour == 0 ? 'selected="selected" ':'') .
+ " 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='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";
+ $result .= "<option " . ($date->hour == 12 ? 'selected="selected" ':'') .
+ " 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='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";
}
}
$result .= "</select> :\n";
- $result .= "<select name='${var}minute'>\n";
- for ($i = 0; $i < 60; $i++) {
+ $result .= "<select $onclick name='${var}minute'>\n";
+ my $selected=0;
+ for my $i ((0,15,30,45,59,undef,0..59)) {
my $printedMinute = $i;
- if ($i < 10) {
+ if (defined($i) && $i < 10) {
$printedMinute = "0" . $printedMinute;
}
- if ($date->min == $i) {
- $result .= "<option selected>";
+ if (!$selected && $date->min == $i) {
+ $result .= "<option selected='selected'>";
+ $selected=1;
} else {
$result .= "<option>";
}
@@ -1606,7 +1895,24 @@ sub render {
}
$result .= "</select>\n";
}
-
+ $result .= ' '.$date->time_zone_short_name().' ';
+ if ($self->{'anytime'}) {
+ $result.=(<<CHECK);
+<script type="text/javascript">
+// <!--
+ function updateCheck(form,name,value) {
+ var checkbox=form[name];
+ checkbox.checked = value;
+ }
+// -->
+</script>
+CHECK
+ $result.=" or <label><input type='checkbox' ";
+ if ($anytime) {
+ $result.=' checked="checked" '
+ }
+ $result.="name='${var}anytime'/>".&mt('Any time').'</label>'
+ }
return $result;
}
@@ -1614,31 +1920,69 @@ sub render {
sub postprocess {
my $self = shift;
my $var = $self->{'variable'};
- my $month = $ENV{'form.' . $var . 'month'};
- my $day = $ENV{'form.' . $var . 'day'};
- my $year = $ENV{'form.' . $var . 'year'};
- my $min = 0;
- my $hour = 0;
- if ($self->{'hoursminutes'}) {
- $min = $ENV{'form.' . $var . 'minute'};
- $hour = $ENV{'form.' . $var . 'hour'};
- }
+ if ($env{'form.' . $var . 'anytime'}) {
+ $helper->{VARS}->{$var} = undef;
+ } else {
+ my $month = $env{'form.' . $var . 'month'};
+ $month ++;
+ my $day = $env{'form.' . $var . 'day'};
+ my $year = $env{'form.' . $var . 'year'};
+ my $min = 0;
+ my $hour = 0;
+ if ($self->{'hoursminutes'}) {
+ $min = $env{'form.' . $var . 'minute'};
+ $hour = $env{'form.' . $var . 'hour'};
+ }
- my $chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);
- # 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
- my $checkDate = localtime($chosenDate);
-
- if ($checkDate->mon != $month || $checkDate->mday != $day ||
- $checkDate->year + 1900 != $year) {
- $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;
+ my ($chosenDate,$checkDate);
+ my $timezone = &Apache::lonlocal::gettimezone();
+ my $dt;
+ eval {
+ $dt = DateTime->new( year => $year,
+ month => $month,
+ day => $day,
+ hour => $hour,
+ minute => $min,
+ second => 0,
+ time_zone => $timezone,
+ );
+ };
+
+ my $error = $@;
+ if (!$error) {
+ $chosenDate = $dt->epoch;
+ $checkDate = &get_date_object($chosenDate);
+ }
+
+ # 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 leap year
+
+ if ($error || $checkDate->mon != $month || $checkDate->mday != $day ||
+ $checkDate->year != $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[$env{'form.'.$var.'month'}]. " $day, $year as a ".
+ "date because it doesn't exist. Please enter a valid date.";
+
+ return 0;
+ }
+ $helper->{VARS}->{$var} = $chosenDate;
}
- $helper->{VARS}->{$var} = $chosenDate;
+ if (defined($self->{VALIDATOR})) {
+ my $validator = eval($self->{VALIDATOR});
+ die 'Died during evaluation of validator 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});
@@ -1646,6 +1990,20 @@ sub postprocess {
return 1;
}
+
+sub get_date_object {
+ my ($epoch) = @_;
+ my $dt = DateTime->from_epoch(epoch => $epoch)
+ ->set_time_zone(&Apache::lonlocal::gettimezone());
+ my $lang = Apache::lonlocal::current_language();
+ if ($lang ne '') {
+ eval {
+ $dt->set_locale($lang);
+ };
+ }
+ return $dt;
+}
+
1;
package Apache::lonhelper::resource;
@@ -1670,7 +2028,10 @@ to false. The "suppressEmptySequences" a
suppressEmptySequences argument to the render routine, which will cause
folders that have all of their contained resources filtered out to also
be filtered out. The 'addstatus' attribute, if true, will add the icon
-and long status display columns to the display.
+and long status display columns to the display. The 'addparts'
+attribute will add in a part selector beside problems that have more
+than 1 part. The 'includecourse' attribute if true, will include
+the toplevel default.sequence in the results.
=head3 SUB-TAGS
@@ -1710,12 +2071,13 @@ and long status display columns to the d
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
+use Apache::lonnet;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::resource',
('resource', 'filterfunc',
'choicefunc', 'valuefunc',
- 'mapurl'));
+ 'mapurl','option'));
}
sub new {
@@ -1737,6 +2099,12 @@ sub start_resource {
$paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'};
$paramHash->{'toponly'} = $token->[2]{'toponly'};
$paramHash->{'addstatus'} = $token->[2]{'addstatus'};
+ $paramHash->{'addparts'} = $token->[2]{'addparts'};
+ if ($paramHash->{'addparts'}) {
+ $helper->declareVar($paramHash->{'variable'}.'_part');
+ }
+ $paramHash->{'closeallpages'} = $token->[2]{'closeallpages'};
+ $paramHash->{'include_top_level_map'} = $token->[2]{'includecourse'};
return '';
}
@@ -1819,6 +2187,42 @@ sub start_mapurl {
sub end_mapurl { return ''; }
+
+sub start_option {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ if (!defined($paramHash->{OPTION_TEXTS})) {
+ $paramHash->{OPTION_TEXTS} = [ ];
+ $paramHash->{OPTION_VARS} = [ ];
+
+ }
+ # 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.
+ # 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};
+ push(@$option_texts, $token->[2]{'text'});
+ push(@$option_vars, $token->[2]{'variable'});
+
+ # Need to create and declare the option variables as well to make them
+ # persistent.
+ #
+ my $varname = $token->[2]{'variable'};
+ $helper->declareVar($varname);
+
+
+ return '';
+}
+
+sub end_option {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ return '';
+}
+
# A note, in case I don't get to this before I leave.
# If someone complains about the "Back" button returning them
# to the previous folder state, instead of returning them to
@@ -1841,21 +2245,27 @@ sub render {
if ($self->{'multichoice'}) {
$result = <<SCRIPT;
-<script>
+<script type="text/javascript">
+// <!--
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
+ if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
}
+// -->
</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
}
@@ -1866,14 +2276,18 @@ BUTTONS
$result .= $buttons;
- my $filterFunc = $self->{FILTER_FUNC};
- my $choiceFunc = $self->{CHOICE_FUNC};
- my $valueFunc = $self->{VALUE_FUNC};
- my $multichoice = $self->{'multichoice'};
+ my $filterFunc = $self->{FILTER_FUNC};
+ my $choiceFunc = $self->{CHOICE_FUNC};
+ my $valueFunc = $self->{VALUE_FUNC};
+ my $multichoice = $self->{'multichoice'};
+ my $option_vars = $self->{OPTION_VARS};
+ my $option_texts = $self->{OPTION_TEXTS};
+ my $addparts = $self->{'addparts'};
+ my $headings_done = 0;
# Evaluate the map url as needed
my $mapUrl;
- if ($self->{EVALUATE_MAP_URL}) {
+ if ($self->{EVAL_MAP_URL}) {
my $mapUrlFunc = eval('sub { my $helper = shift; my $state = shift; ' .
$self->{MAP_URL} . '}');
$mapUrl = &$mapUrlFunc($helper, $self);
@@ -1881,38 +2295,130 @@ BUTTONS
$mapUrl = $self->{MAP_URL};
}
+ my %defaultSymbs;
+ if (defined($self->{DEFAULT_VALUE})) {
+ my $valueFunc = eval($self->{DEFAULT_VALUE});
+ die 'Error in default value code for variable ' .
+ $self->{'variable'} . ', Perl said: ' . $@ if $@;
+ my @defaultSymbs = &$valueFunc($helper, $self);
+ if (!$multichoice && @defaultSymbs) { # only allowed 1
+ @defaultSymbs = ($defaultSymbs[0]);
+ }
+ %defaultSymbs = map { if ($_) {($_,1) } } @defaultSymbs;
+ delete($defaultSymbs{''});
+ }
+
# 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) ;-)
my $checked = 0;
my $renderColFunc = sub {
my ($resource, $part, $params) = @_;
+ my $result = "";
+
+ if(!$headings_done) {
+ if ($option_texts) {
+ foreach my $text (@$option_texts) {
+ $result .= "<th>$text</th>";
+ }
+ }
+ $result .= "<th>Select</th>";
+ $result .= "</tr><tr>"; # Close off the extra row and start a new one.
+ $headings_done = 1;
+ }
my $inputType;
if ($multichoice) { $inputType = 'checkbox'; }
else {$inputType = 'radio'; }
if (!&$choiceFunc($resource)) {
- return '<td> </td>';
+ $result .= '<td> </td>';
+ return $result;
} else {
- my $col = "<td><input type='$inputType' name='${var}.forminput' ";
- if (!$checked && !$multichoice) {
- $col .= "checked ";
- $checked = 1;
- }
- if ($multichoice) { # all resources start checked; see bug 1174
- $col .= "checked ";
- $checked = 1;
+ my $col = "";
+ my $raw_name = &$valueFunc($resource);
+ my $resource_name =
+ HTML::Entities::encode($raw_name,"<>&\"'");
+ if($option_vars) {
+ foreach my $option_var (@$option_vars) {
+ 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>";
+ }
}
- $col .= "value='" .
- HTML::Entities::encode(&$valueFunc($resource))
- . "' /></td>";
- return $col;
+
+ $col .= "<td align='center'><input type='$inputType' name='${var}_forminput' ";
+ if (%defaultSymbs) {
+ my $symb=$resource->symb();
+ if (exists($defaultSymbs{$symb})) {
+ $col .= "checked='checked' ";
+ $checked = 1;
+ }
+ } else {
+ if (!$checked && !$multichoice) {
+ $col .= "checked='checked' ";
+ $checked = 1;
+ }
+ if ($multichoice) { # all resources start checked; see bug 1174
+ $col .= "checked='checked' ";
+ $checked = 1;
+ }
+ }
+ $col .= "value='" . $resource_name . "' /></td>";
+
+ return $result.$col;
}
};
+ my $renderPartsFunc = sub {
+ my ($resource, $part, $params) = @_;
+ my $col= "<td>";
+ my $id=$resource->{ID};
+ my $resource_name =
+ &HTML::Entities::encode(&$valueFunc($resource),"<>&\"'");
+ if ($addparts && (scalar(@{$resource->parts}) > 1)) {
+ $col .= "<select onclick=\"javascript:updateRadio(this.form,'${var}_forminput','$resource_name');updateHidden(this.form,'$id','${var}');\" name='part_${id}_forminput'>\n";
+ $col .= "<option value=\"$part\">All Parts</option>\n";
+ foreach my $part (@{$resource->parts}) {
+ $col .= "<option value=\"$part\">Part: $part</option>\n";
+ }
+ $col .= "</select>";
+ }
+ $col .= "</td>";
+ };
+ $result.=(<<RADIO);
+<script type="text/javascript">
+// <!--
+ function updateRadio(form,name,value) {
+ var radiobutton=form[name];
+ for (var i=0; i<radiobutton.length; i++) {
+ if (radiobutton[i].value == value) {
+ radiobutton[i].checked = true;
+ break;
+ }
+ }
+ }
+ function updateHidden(form,id,name) {
+ var select=form['part_'+id+'_forminput'];
+ var hidden=form[name+'_part_forminput'];
+ var which=select.selectedIndex;
+ hidden.value=select.options[which].value;
+ }
+// -->
+</script>
+<input type="hidden" name="${var}_part_forminput" />
- $ENV{'form.condition'} = !$self->{'toponly'};
- my $cols = [$renderColFunc, Apache::lonnavmaps::resource()];
+RADIO
+ $env{'form.condition'} = !$self->{'toponly'};
+ my $cols = [$renderColFunc];
+ if ($self->{'addparts'}) { push(@$cols, $renderPartsFunc); }
+ push(@$cols, Apache::lonnavmaps::resource());
if ($self->{'addstatus'}) {
push @$cols, (Apache::lonnavmaps::part_status_summary());
@@ -1922,7 +2428,9 @@ BUTTONS
'showParts' => 0,
'filterFunc' => $filterFunc,
'resource_no_folder_link' => 1,
+ 'closeAllPages' => $self->{'closeallpages'},
'suppressEmptySequences' => $self->{'suppressEmptySequences'},
+ 'include_top_level_map' => $self->{'include_top_level_map'},
'iterator_map' => $mapUrl }
);
@@ -1980,6 +2488,10 @@ selection. Defaults to false.
If true, only active students and course personnel will be
shown. Defaults to false.
+=item * B<emptyallowed>:
+
+If true, the selection of no users is allowed. Defaults to false.
+
=back
=cut
@@ -1987,8 +2499,8 @@ shown. Defaults to false.
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
-
-
+use Apache::lonlocal;
+use Apache::lonnet;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::student',
@@ -2011,10 +2523,11 @@ sub start_student {
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
$paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
- $paramHash->{'sctiveonly'} = $token->[2]{'activeonly'};
+ $paramHash->{'activeonly'} = $token->[2]{'activeonly'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
+ $paramHash->{'emptyallowed'} = $token->[2]{'emptyallowed'};
}
@@ -2033,120 +2546,98 @@ sub render {
my $buttons = '';
my $var = $self->{'variable'};
- if ($self->{'multichoice'}) {
- $result = <<SCRIPT;
-<script>
- function checkall(value, checkName) {
- for (i=0; i<document.forms.helpform.elements.length; i++) {
- ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
- document.forms.helpform.elements[i].checked=value;
- }
- }
- }
-</script>
-SCRIPT
- $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" />
-<br />
-BUTTONS
- }
if (defined $self->{ERROR_MSG}) {
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
}
- my $choices = [];
+ my %defaultUsers;
+ if (defined($self->{DEFAULT_VALUE})) {
+ my $valueFunc = eval($self->{DEFAULT_VALUE});
+ die 'Error in default value code for variable ' .
+ $self->{'variable'} . ', Perl said: ' . $@ if $@;
+ my @defaultUsers = &$valueFunc($helper, $self);
+ if (!$self->{'multichoice'} && @defaultUsers) { # only allowed 1
+ @defaultUsers = ($defaultUsers[0]);
+ }
+ %defaultUsers = map { if ($_) {($_,1) } } @defaultUsers;
+ delete($defaultUsers{''});
+ }
+
+
+ my ($course_personnel,
+ $current_members,
+ $expired_members,
+ $future_members) =
+ &Apache::lonselstudent::get_people_in_class($env{'request.course.sec'});
+
+
# 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], '', $_];
- }
- }
- }
+ unshift @$current_members, (@$course_personnel);
}
- # 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 ($classlist->{$a}->[$section] ne $classlist->{$b}->[$section]) {
- return $classlist->{$a}->[$section] cmp $classlist->{$b}->[$section];
- }
- 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], 'Student'];
- }
+ # Current personel
+
+ $result .= '<h4>'.&mt('Select Currently Enrolled Students and Active Course Personnel').'</h4>';
+ $result .= &Apache::lonselstudent::render_student_list( $current_members,
+ "helpform",
+ "current",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 1);
+
+
+ # If activeonly is not set then we can also give the expired students:
+ #
+ if (!$self->{'activeonly'} && ((scalar(@$future_members)) > 0)) {
+
+ # And future.
+
+ $result .= '<h4>'.&mt('Select Future Enrolled Students and Future Course Personnel').'</h4>';
+
+ $result .= &Apache::lonselstudent::render_student_list( $future_members,
+ "helpform",
+ "future",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 0);
+ }
+ if (!$self->{'activeonly'} && ((scalar(@$expired_members)) > 0)) {
+ # Past
+
+ $result .= '<h4>'.&mt('Select Previously Enrolled Students and Inactive Course Personnel').'</h4>';
+ $result .= &Apache::lonselstudent::render_student_list($expired_members,
+ "helpform",
+ "past",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 0);
}
- my $name = $self->{'coursepersonnel'} ? 'Name' : 'Student Name';
- my $type = 'radio';
- if ($self->{'multichoice'}) { $type = 'checkbox'; }
- $result .= "<table cellspacing='2' cellpadding='2' border='0'>\n";
- $result .= "<tr><td></td><td align='center'><b>$name</b></td>".
- "<td align='center'><b>Section</b></td>" .
- "<td align='center'><b>Role</b></td></tr>";
- my $checked = 0;
- for my $choice (@$choices) {
- $result .= "<tr><td><input type='$type' name='" .
- $self->{'variable'} . '.forminput' . "'";
-
- if (!$self->{'multichoice'} && !$checked) {
- $result .= " checked ";
- $checked = 1;
- }
- $result .=
- " value='" . HTML::Entities::encode($choice->[0] . ':' . $choice->[2])
- . "' /></td><td>"
- . HTML::Entities::encode($choice->[1])
- . "</td><td align='center'>"
- . HTML::Entities::encode($choice->[2])
- . "</td>\n<td>"
- . HTML::Entities::encode($choice->[3]) . "</td></tr>\n";
- }
- $result .= "</table>\n\n";
- $result .= $buttons;
-
return $result;
}
sub postprocess {
my $self = shift;
- my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'};
- if (!$result) {
- $self->{ERROR_MSG} = 'You must choose at least one student '.
- 'to continue.';
+ my $result = $env{'form.' . $self->{'variable'} . '_forminput'};
+ if (!$result && !$self->{'emptyallowed'}) {
+ if ($self->{'coursepersonnel'}) {
+ $self->{ERROR_MSG} =
+ &mt('You must choose at least one user to continue.');
+ } else {
+ $self->{ERROR_MSG} =
+ &mt('You must choose at least one student to continue.');
+ }
return 0;
}
@@ -2212,7 +2703,8 @@ viewing the files.
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
-
+use Apache::lonlocal;
+use Apache::lonnet;
use Apache::lonpubdir; # for getTitleString
BEGIN {
@@ -2287,6 +2779,13 @@ sub start_filefilter {
sub end_filefilter { return ''; }
+{
+ # used to generate unique id attributes for <input> tags.
+ # internal use only.
+ my $id=0;
+ sub new_id { return $id++;}
+}
+
sub render {
my $self = shift;
my $result = '';
@@ -2310,11 +2809,12 @@ sub render {
if ($self->{'multichoice'}) {
$result = <<SCRIPT;
-<script>
+<script type="text/javascript">
+// <!--
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
+ if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
@@ -2328,18 +2828,25 @@ 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
}
@@ -2351,23 +2858,25 @@ BUTTONS
# If the subdirectory is in local CSTR space
my $metadir;
if ($subdir =~ m|/home/([^/]+)/public_html/(.*)|) {
- my $user = $1;
- my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
+ my ($user,$domain)=
+ &Apache::loncacc::constructaccess($subdir,
+ $Apache::lonnet::perlvar{'lonDefDomain'});
$metadir='/res/'.$domain.'/'.$user.'/'.$2;
- @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
+ @fileList = &Apache::lonnet::dirlist($subdir,$domain,$user,undef,undef,'/');
} elsif ($subdir =~ m|^~([^/]+)/(.*)$|) {
$subdir='/home/'.$1.'/public_html/'.$2;
- my $user = $1;
- my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
+ my ($user,$domain)=
+ &Apache::loncacc::constructaccess($subdir,
+ $Apache::lonnet::perlvar{'lonDefDomain'});
$metadir='/res/'.$domain.'/'.$user.'/'.$2;
- @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
+ @fileList = &Apache::lonnet::dirlist($subdir,$domain,$user,undef,undef,'/');
} else {
# local library server resource space
- @fileList = &Apache::lonnet::dirlist($subdir, $ENV{'user.domain'}, $ENV{'user.name'}, '');
+ @fileList = &Apache::lonnet::dirlist($subdir,$env{'user.domain'},$env{'user.name'},undef,undef,'/');
}
# Sort the fileList into order
- @fileList = sort @fileList;
+ @fileList = sort {lc($a) cmp lc($b)} @fileList;
$result .= $buttons;
@@ -2419,14 +2928,16 @@ BUTTONS
if ($status eq 'Published' && $helper->{VARS}->{'construction'}) {
$onclick = 'onclick="a=1" ';
}
+ my $id = &new_id();
$result .= '<tr><td align="right"' . " bgcolor='$color'>" .
"<input $onclick type='$type' name='" . $var
- . ".forminput' value='" . HTML::Entities::encode($fileName) .
+ . "_forminput' ".qq{id="$id"}." value='" . HTML::Entities::encode($fileName,"<>&\"'").
"'";
if (!$self->{'multichoice'} && $choices == 0) {
- $result .= ' checked';
+ $result .= ' checked="checked"';
}
- $result .= "/></td><td bgcolor='$color'>" . $file . "</td>" .
+ $result .= "/></td><td bgcolor='$color'>".
+ qq{<label for="$id">}. $file . "</label></td>" .
"<td bgcolor='$color'>$title</td>" .
"<td bgcolor='$color'>$status</td>" . "</tr>\n";
$choices++;
@@ -2454,10 +2965,14 @@ sub fileState {
my $constructionSpaceDir = shift;
my $file = shift;
+ my ($uname,$udom)=($env{'user.name'},$env{'user.domain'});
+ if ($env{'request.role'}=~/^ca\./) {
+ (undef,$udom,$uname)=split(/\//,$env{'request.role'});
+ }
my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
my $subdirpart = $constructionSpaceDir;
- $subdirpart =~ s/^\/home\/$ENV{'user.name'}\/public_html//;
- my $resdir = $docroot . '/res/' . $ENV{'user.domain'} . '/' . $ENV{'user.name'} .
+ $subdirpart =~ s/^\/home\/$uname\/public_html//;
+ my $resdir = $docroot . '/res/' . $udom . '/' . $uname .
$subdirpart;
my @constructionSpaceFileStat = stat($constructionSpaceDir . '/' . $file);
@@ -2477,7 +2992,7 @@ sub fileState {
sub postprocess {
my $self = shift;
- my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'};
+ my $result = $env{'form.' . $self->{'variable'} . '_forminput'};
if (!$result) {
$self->{ERROR_MSG} = 'You must choose at least one file '.
'to continue.';
@@ -2502,8 +3017,12 @@ package Apache::lonhelper::section;
<section> allows the user to choose one or more sections from the current
course.
-It takes the standard attributes "variable", "multichoice", and
-"nextstate", meaning what they do for most other elements.
+It takes the standard attributes "variable", "multichoice",
+"allowempty" and "nextstate", meaning what they do for most other
+elements.
+
+also takes a boolean 'onlysections' whcih will restrict this to only
+have sections and not include groups
=cut
@@ -2533,6 +3052,7 @@ sub start_section {
$paramHash->{'variable'} = $token->[2]{'variable'};
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
@@ -2542,18 +3062,29 @@ sub start_section {
my $section = Apache::loncoursedata::CL_SECTION();
my $classlist = Apache::loncoursedata::get_classlist();
- foreach (keys %$classlist) {
- my $sectionName = $classlist->{$_}->[$section];
- if (!$sectionName) {
+ foreach my $user (keys(%$classlist)) {
+ my $section_name = $classlist->{$user}[$section];
+ if (!$section_name) {
$choices{"No section assigned"} = "";
} else {
- $choices{$sectionName} = $sectionName;
+ $choices{$section_name} = $section_name;
}
}
- for my $sectionName (sort(keys(%choices))) {
-
- push @{$paramHash->{CHOICES}}, [$sectionName, $sectionName];
+ if (exists($choices{"No section assigned"})) {
+ push(@{$paramHash->{CHOICES}},
+ ['No section assigned','No section assigned']);
+ delete($choices{"No section assigned"});
+ }
+ for my $section_name (sort {lc($a) cmp lc($b) } (keys(%choices))) {
+ push @{$paramHash->{CHOICES}}, [$section_name, $section_name];
+ }
+ return if ($token->[2]{'onlysections'});
+
+ # add in groups to the end of the list
+ my %curr_groups = &Apache::longroup::coursegroups();
+ foreach my $group_name (sort(keys(%curr_groups))) {
+ push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}
}
@@ -2567,6 +3098,70 @@ sub end_section {
}
1;
+package Apache::lonhelper::group;
+
+=pod
+
+=head2 Element: groupX<group, helper element>
+
+<group> allows the user to choose one or more groups from the current course.
+
+It takes the standard attributes "variable", "multichoice",
+ "allowempty" and "nextstate", meaning what they do for most other
+ elements.
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::choices");
+use strict;
+
+BEGIN {
+ &Apache::lonhelper::register('Apache::lonhelper::group',
+ ('group'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::choices->new();
+ bless($ref);
+}
+
+sub start_group {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{CHOICES} = [];
+
+ $paramHash->{'variable'} = $token->[2]{'variable'};
+ $helper->declareVar($paramHash->{'variable'});
+ $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
+ if (defined($token->[2]{'nextstate'})) {
+ $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
+ }
+
+ # Populate the CHOICES element
+ my %choices;
+
+ my %curr_groups = &Apache::longroup::coursegroups();
+ foreach my $group_name (sort {lc($a) cmp lc($b)} (keys(%curr_groups))) {
+ push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
+ }
+}
+
+sub end_group {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ Apache::lonhelper::group->new();
+}
+1;
+
package Apache::lonhelper::string;
=pod
@@ -2586,6 +3181,7 @@ string honors the validation function, i
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
+use Apache::lonlocal;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::string',
@@ -2629,10 +3225,10 @@ sub render {
my $result = '';
if (defined $self->{ERROR_MSG}) {
- $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
+ $result .= '<p><font color="#FF0000">' . $self->{ERROR_MSG} . '</font></p>';
}
- $result .= '<input type="string" name="' . $self->{'variable'} . '.forminput"';
+ $result .= '<input type="string" name="' . $self->{'variable'} . '_forminput"';
if (defined($self->{'size'})) {
$result .= ' size="' . $self->{'size'} . '"';
@@ -2659,7 +3255,7 @@ sub postprocess {
if (defined($self->{VALIDATOR})) {
my $validator = eval($self->{VALIDATOR});
- die 'Died during evaluation of evaulation code; Perl said: ' . $@ if $@;
+ die 'Died during evaluation of validator code; Perl said: ' . $@ if $@;
my $invalid = &$validator($helper, $state, $self, $self->getValue());
if ($invalid) {
$self->{ERROR_MSG} = $invalid;
@@ -2683,7 +3279,7 @@ package Apache::lonhelper::general;
=head2 General-purpose tag: <exec>X<exec, helper tag>
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
+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:
"sub { my $helper = shift; my $state = shift;" and
@@ -2704,6 +3300,9 @@ be able to call methods on it.
=cut
+use Apache::lonlocal;
+use Apache::lonnet;
+
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::general',
'exec', 'condition', 'clause',
@@ -2762,7 +3361,8 @@ sub start_clause {
die 'Error in clause of condition, Perl said: ' . $@ if $@;
if (!&$clause($helper, $paramHash)) {
# Discard all text until the /condition.
- &Apache::lonxml::get_all_text('/condition', $parser);
+ my $end_tag = $paramHash->{SKIPTAG} || '/condition';
+ &Apache::lonxml::get_all_text($end_tag, $parser);
}
}
@@ -2825,12 +3425,16 @@ will make a "Finish Helper" button that
which is useful for the Course Initialization helper so the users never see
the old values taking effect.
+If the parameter "restartCourse" is not true a 'Finish' Button will be
+presented that takes the user back to whatever was defined as <exitpage>
+
=cut
no strict;
@ISA = ("Apache::lonhelper::element");
use strict;
-
+use Apache::lonlocal;
+use Apache::lonnet;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::final',
('final', 'exitpage'));
@@ -2915,40 +3519,55 @@ 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>';
}
+ my $actionURL = $self->{EXIT_PAGE};
+ my $targetURL = '';
+ my $finish=&mt('Finish');
if ($self->{'restartCourse'}) {
- my $targetURL = '/adm/menu';
- if ($ENV{'course.'.$ENV{'request.course.id'}.'.clonedfrom'}) {
+ $actionURL = '/adm/roles';
+ $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';
}
- $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='$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" .
- "</form></center>";
+ my $finish=&mt('Finish Course Initialization');
}
+ my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
+ 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" .
+ "<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>";
return $result;
}
sub overrideForm {
- my $self = shift;
- return $self->{'restartCourse'};
+ return 1;
}
1;
package Apache::lonhelper::parmwizfinal;
-# This is the final state for the parmwizard. It is not generally useful,
+# This is the final state for the parm helper. It is not generally useful,
# so it is not perldoc'ed. It does its own processing.
# It is represented with <parmwizfinal />, and
# should later be moved to lonparmset.pm .
@@ -2956,6 +3575,8 @@ package Apache::lonhelper::parmwizfinal;
no strict;
@ISA = ('Apache::lonhelper::element');
use strict;
+use Apache::lonlocal;
+use Apache::lonnet;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::parmwizfinal',
@@ -2997,6 +3618,11 @@ sub render {
'answer_date' => "0_answerdate",
'tries' => '0_maxtries',
'weight' => '0_weight' );
+ my %realParmName = ('open_date' => "opendate",
+ 'due_date' => "duedate",
+ 'answer_date' => "answerdate",
+ 'tries' => 'maxtries',
+ 'weight' => 'weight' );
my $affectedResourceId = "";
my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}};
@@ -3004,46 +3630,104 @@ sub render {
my $resourceString;
my $symb;
my $paramlevel;
-
+
# Print the granularity, depending on the action
if ($vars->{GRANULARITY} eq 'whole_course') {
- $resourceString .= '<li>for <b>all resources in the course</b></li>';
- $level = 9; # general course, see lonparmset.pm perldoc
+ $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') {
+ $level = 9;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 6;
+ } else {
+ $level = 3;
+ }
$affectedResourceId = "0.0";
$symb = 'a';
$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();
- $navmap->untieHashes();
- $resourceString .= "<li>for the map named <b>$title</b></li>";
- $level = 8;
+ 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') {
+ $level = 8;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 5;
+ } else {
+ $level = 2;
+ }
$affectedResourceId = $vars->{RESOURCE_ID};
$paramlevel = 'map';
} else {
+ my $part = $vars->{RESOURCE_ID_part};
+ if ($part ne 'All Parts' && $part) { $parm_name=~s/^0/$part/; } else { $part=&mt('All Parts'); }
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>";
- $level = 7;
+ 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') {
+ $level = 7;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 4;
+ } else {
+ $level = 1;
+ }
$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>';
+ 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='".
+ $realParmName{$vars->{ACTION_TYPE}}."' />\n";
+ if ($vars->{GRANULARITY} eq 'resource') {
+ $result .= "<input type='hidden' name='symb' value='".
+ HTML::Entities::encode($symb,"'<>&\"") . "' />\n";
+ } elsif ($vars->{GRANULARITY} eq 'map') {
+ $result .= "<input type='hidden' name='pschp' value='".
+ $affectedResourceId."' />\n";
+ }
+ my $part = $vars->{RESOURCE_ID_part};
+ if ($part eq 'All Parts' || !$part) { $part=0; }
+ $result .= "<input type='hidden' name='psprt' value='".
+ HTML::Entities::encode($part,"'<>&\"") . "' />\n";
+
+ $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>';
+ my $extra;
if ($vars->{ACTION_TYPE} eq 'tries') {
- $result .= ' to <b>' . $vars->{TRIES} . '</b>';
+ $extra = $vars->{TRIES};
}
if ($vars->{ACTION_TYPE} eq 'weight') {
- $result .= ' to <b>' . $vars->{WEIGHT} . '</b>';
+ $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' ||
@@ -3065,6 +3749,8 @@ sub render {
} elsif ($vars->{ACTION_TYPE} eq 'tries') {
$result .= "<input type='hidden' name='pres_value' " .
"value='" . $vars->{TRIES} . "' />\n";
+ $result .= "<input type='hidden' name='pres_type' " .
+ "value='int_pos' />\n";
} elsif ($vars->{ACTION_TYPE} eq 'weight') {
$result .= "<input type='hidden' name='pres_value' " .
"value='" . $vars->{WEIGHT} . "' />\n";
@@ -3074,34 +3760,33 @@ sub render {
# Print targets
if ($vars->{TARGETS} eq 'course') {
- $result .= '<li>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>for section <b>$section</b></li>";
- $level -= 3;
- $result .= "<input type='hidden' name='csec' value='" .
- HTML::Entities::encode($section) . "' />\n";
+ $result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';
+ $result .= "<input type='hidden' name='csec' value='" .
+ HTML::Entities::encode($section,"'<>&\"") . "' />\n";
+ } elsif ($vars->{TARGETS} eq 'group') {
+ my $group = $vars->{GROUP_NAME};
+ $result .= '<li>'.&mt('for group [_1]',"<b>$group</b>").'</li>';
+ $result .= "<input type='hidden' name='cgroup' value='" .
+ HTML::Entities::encode($group,"'<>&\"") . "' />\n";
} else {
# FIXME: This is probably wasteful! Store the name!
my $classlist = Apache::loncoursedata::get_classlist();
- my $username = $vars->{USER_NAME};
- # 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>";
- $level -= 6;
- my ($uname, $udom) = split /:/, $vars->{USER_NAME};
+ my ($uname,$udom)=split(':',$vars->{USER_NAME});
+ my $name = $classlist->{$uname.':'.$udom}->[6];
+ $result .= '<li>'.&mt('for [_1]',"<b>$name</b>").'</li>';
$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
if ($vars->{ACTION_TYPE} ne 'tries' && $vars->{ACTION_TYPE} ne 'weight') {
- $result .= "<li>to <b>" . ctime($vars->{PARM_DATE}) . "</b> (" .
- Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE})
- . ")</li>\n";
+ 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";
}
# print pres_marker
@@ -3110,11 +3795,10 @@ sub render {
# Make the table appear
$result .= "\n<input type='hidden' value='true' name='prevvisit' />";
- $result .= "\n<input type='hidden' value='all' name='pschp' />";
$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;
}