+
$stateTitle
:
+B
-=over 4
-
-=item * process_multiple_choices(formName, varName): Process the form
-element named "formName" and place the selected items into the helper
-variable named varName. This is for things like checkboxes or
-multiple-selection listboxes where the user can select more then
-one entry. The selected entries are delimited by triple pipes in
-the helper variables, like this:
-
- CHOICE_1|||CHOICE_2|||CHOICE_3
-
-=back
+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;"
+and "}". It is expected to return a string describing what it did, which
+may be an empty string. See course initialization helper for an example. This is
+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
+
+Each element that accepts user input can contain a "defaultvalue" tag that,
+when surrounded by "sub { my $helper = shift; my $state = shift; " and "}",
+will form a subroutine that when called will provide a default value for
+the element. How this value is interpreted by the element is specific to
+the element itself, and possibly the settings the element has (such as
+multichoice vs. single choice for tags).
+
+This is also intended for things like the course initialization wizard, 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
+some setting accidentally.
+
+Again, see the course initialization helper for examples.
+
+B
+
+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.
+
+B
+
+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
+this method.
=cut
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::element',
- ('nextstate'));
+ ('nextstate', 'finalcode',
+ 'defaultvalue', 'validator'));
}
# Because we use the param hash, this is often a sufficent
@@ -729,6 +837,52 @@ sub start_nextstate {
sub end_nextstate { return ''; }
+sub start_finalcode {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{FINAL_CODE} = &Apache::lonxml::get_all_text('/finalcode',
+ $parser);
+ return '';
+}
+
+sub end_finalcode { return ''; }
+
+sub start_defaultvalue {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{DEFAULT_VALUE} = &Apache::lonxml::get_all_text('/defaultvalue',
+ $parser);
+ $paramHash->{DEFAULT_VALUE} = 'sub { my $helper = shift; my $state = shift;' .
+ $paramHash->{DEFAULT_VALUE} . '}';
+ return '';
+}
+
+sub end_defaultvalue { return ''; }
+
+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;
}
@@ -745,26 +899,9 @@ sub overrideForm {
return 0;
}
-sub process_multiple_choices {
+sub getValue {
my $self = shift;
- my $formname = shift;
- my $var = shift;
-
- # Must extract values from data directly, as there
- # may be more then one.
- my @values;
- for my $formparam (split (/&/, $ENV{QUERY_STRING})) {
- my ($name, $value) = split(/=/, $formparam);
- if ($name ne $formname) {
- next;
- }
- $value =~ tr/+/ /;
- $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg;
- push @values, $value;
- }
- $helper->{VARS}->{$var} = join('|||', @values);
-
- return;
+ return $helper->{VARS}->{$self->{'variable'}};
}
1;
@@ -875,6 +1012,10 @@ the result is stored in.
takes an attribute "multichoice" which, if set to a true
value, will allow the user to select multiple choices.
+ takes an attribute "allowempty" which, if set to a true
+value, will allow the user to select none of the choices without raising
+an error message.
+
B
can have the following subtags:
@@ -924,6 +1065,18 @@ 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
+
+Choices supports default values both in multichoice and single choice mode.
+In single choice mode, have the defaultvalue tag's function return the
+computer value of the box you want checked. If the function returns a value
+that does not correspond to any of the choices, the default behavior of selecting
+the first choice will be preserved.
+
+For multichoice, return a string with the computer values you want checked,
+delimited by triple pipes. Note this matches how the result of the
+tag is stored in the {VARS} hash.
+
=cut
no strict;
@@ -949,9 +1102,10 @@ sub start_choices {
}
# Need to initialize the choices list, so everything can assume it exists
- $paramHash->{'variable'} = $token->[2]{'variable'};
+ $paramHash->{'variable'} = $token->[2]{'variable'} if (!defined($paramHash->{'variable'}));
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
$paramHash->{CHOICES} = [];
return '';
}
@@ -988,7 +1142,6 @@ sub end_choice {
}
sub render {
- # START HERE: Replace this with correct choices code.
my $self = shift;
my $var = $self->{'variable'};
my $buttons = '';
@@ -997,17 +1150,25 @@ sub render {
if ($self->{'multichoice'}) {
$result .= <
- function checkall(value) {
+ function checkall(value, checkName) {
for (i=0; i
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) {
$buttons = <\n\n";
+ 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 ''; };
+ }
+
+ # Process which choices should be checked.
+ if ($self->{'multichoice'}) {
+ for my $selectedChoice (split(/\|\|\|/, (&$checkedChoicesFunc($helper, $self)))) {
+ $checkedChoices{$selectedChoice} = 1;
+ }
+ } else {
+ # 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;
+ }
+ }
+
my $type = "radio";
if ($self->{'multichoice'}) { $type = 'checkbox'; }
- my $checked = 0;
foreach my $choice (@{$self->{CHOICES}}) {
$result .= "\n \n";
$result .= " takes an attribute "variable" to control which helper variable
+the result is stored in.
+
+B
+
+, which acts just as it does in the "choices" element.
+
+=back
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+
+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 .= '' . $self->{ERROR_MSG} . ' \n";
+ foreach my $choice (@{$self->{CHOICES}}) {
+ $result .= "[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 .= ">" . $choiceLabel . "\n";
+ }
+ $result .= " \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})) {
@@ -1308,7 +1650,10 @@ variable stores the results. It also tak
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.
+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.
B
@@ -1369,6 +1714,7 @@ sub start_resource {
$paramHash->{'variable'} = $token->[2]{'variable'};
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'};
$paramHash->{'toponly'} = $token->[2]{'toponly'};
return '';
}
@@ -1474,10 +1820,10 @@ sub render {
if ($self->{'multichoice'}) {
$result = <
- function checkall(value) {
+ function checkall(value, checkName) {
for (i=0; i
- function checkall(value) {
+ function checkall(value, checkName) {
for (i=0; i
SCRIPT
$buttons = <' . $self->{ERROR_MSG} . '
- function checkall(value) {
+ function checkall(value, checkName) {
for (i=0; i' . $self->{ERROR_MSG} . ' ';
+ $result .= '';
# Keeps track if there are no choices, prints appropriate error
# if there are none.
my $choices = 0;
- my $type = 'radio';
- if ($self->{'multichoice'}) {
- $type = 'checkbox';
- }
# Print each legitimate file choice.
for my $file (@fileList) {
$file = (split(/&/, $file))[0];
@@ -1886,14 +2283,47 @@ BUTTONS
}
my $fileName = $subdir .'/'. $file;
if (&$filterFunc($file)) {
- $result .= '' .
- " " .
+ " " . $file . " " . $file . " " .
+ "$title " .
+ "$status " . "\n";
$choices++;
}
}
@@ -1909,6 +2339,37 @@ BUTTONS
return $result;
}
+# Determine the state of the file: Published, unpublished, modified.
+# Return the color it should be in and a label as a two-element array
+# reference.
+# Logic lifted from lonpubdir.pm, even though I don't know that it's still
+# the most right thing to do.
+
+sub fileState {
+ my $constructionSpaceDir = shift;
+ my $file = shift;
+
+ 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;
+
+ my @constructionSpaceFileStat = stat($constructionSpaceDir . '/' . $file);
+ my @resourceSpaceFileStat = stat($resdir . '/' . $file);
+ if (!@resourceSpaceFileStat) {
+ return ['Unpublished', '#FFCCCC'];
+ }
+
+ my $constructionSpaceFileModified = $constructionSpaceFileStat[9];
+ my $resourceSpaceFileModified = $resourceSpaceFileStat[9];
+
+ if ($constructionSpaceFileModified > $resourceSpaceFileModified) {
+ return ['Modified', '#FFFFCC'];
+ }
+ return ['Published', '#CCFFCC'];
+}
+
sub postprocess {
my $self = shift;
my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'};
@@ -1918,10 +2379,6 @@ sub postprocess {
return 0;
}
- if ($self->{'multichoice'}) {
- $self->process_multiple_choices($self->{'variable'}.'.forminput',
- $self->{'variable'});
- }
if (defined($self->{NEXTSTATE})) {
$helper->changeState($self->{NEXTSTATE});
}
@@ -2005,6 +2462,115 @@ sub end_section {
}
1;
+package Apache::lonhelper::string;
+
+=pod
+
+=head2 Element: string
+
+string elements provide a string entry field for the user. string elements
+take the usual 'variable' and 'nextstate' parameters. string elements
+also pass through 'maxlength' and 'size' attributes to the input tag.
+
+string honors the defaultvalue tag, if given.
+
+string honors the validation function, if given.
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+
+BEGIN {
+ &Apache::lonhelper::register('Apache::lonhelper::string',
+ ('string'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::element->new();
+ bless($ref);
+}
+
+# CONSTRUCTION: Construct the message element from the XML
+sub start_string {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{'variable'} = $token->[2]{'variable'};
+ $helper->declareVar($paramHash->{'variable'});
+ $paramHash->{'nextstate'} = $token->[2]{'nextstate'};
+ $paramHash->{'maxlength'} = $token->[2]{'maxlength'};
+ $paramHash->{'size'} = $token->[2]{'size'};
+
+ return '';
+}
+
+sub end_string {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ Apache::lonhelper::string->new();
+ return '';
+}
+
+sub render {
+ my $self = shift;
+ my $result = '';
+
+ if (defined $self->{ERROR_MSG}) {
+ $result .= '' . $self->{ERROR_MSG} . ' is a special element that works with helpers that use the
+tag. It goes through all the states and elements, executing the
+snippets and collecting the results. Finally, it takes the user out of the
+helper, going to a provided page.
+
+If the parameter "restartCourse" is true, this will override the buttons and
+will make a "Finish Helper" button that will re-initialize the course for them,
+which is useful for the Course Initialization helper so the users never see
+the old values taking effect.
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+
+BEGIN {
+ &Apache::lonhelper::register('Apache::lonhelper::final',
+ ('final', 'exitpage'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::element->new();
+ bless($ref);
+}
+
+sub start_final {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{'restartCourse'} = $token->[2]{'restartCourse'};
+
+ return '';
+}
+
+sub end_final {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ Apache::lonhelper::final->new();
+
+ return '';
+}
+
+sub start_exitpage {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{EXIT_PAGE} = &Apache::lonxml::get_all_text('/exitpage',
+ $parser);
+
+ return '';
+}
+
+sub end_exitpage { return ''; }
+
+sub render {
+ my $self = shift;
+
+ my @results;
+
+ # Collect all the results
+ for my $stateName (keys %{$helper->{STATES}}) {
+ my $state = $helper->{STATES}->{$stateName};
+
+ for my $element (@{$state->{ELEMENTS}}) {
+ if (defined($element->{FINAL_CODE})) {
+ # Compile the code.
+ my $code = 'sub { my $helper = shift; my $element = shift; '
+ . $element->{FINAL_CODE} . '}';
+ $code = eval($code);
+ die 'Error while executing final code for element with var ' .
+ $element->{'variable'} . ', Perl said: ' . $@ if $@;
+
+ my $result = &$code($helper, $element);
+ if ($result) {
+ push @results, $result;
+ }
+ }
+ }
+ }
+
+ my $result;
+
+ if (scalar(@results) != 0) {
+ $result .= "\n";
+ for my $re (@results) {
+ $result .= ' ' . $re . " \n";
+ }
+
+ if (!@results) {
+ $result .= ' No changes were made to current settings. ';
+ }
+
+ $result .= ' ';
+ }
+
+ if ($self->{'restartCourse'}) {
+ $result .= "\n" .
+ " ";
+ }
+
+ return $result;
+}
+
+sub overrideForm {
+ my $self = shift;
+ return $self->{'restartCourse'};
+}
+
+1;
+
package Apache::lonhelper::parmwizfinal;
# This is the final state for the parmwizard. It is not generally useful,
@@ -2180,20 +2879,59 @@ sub render {
# FIXME: Unify my designators with the standard ones
my %dateTypeHash = ('open_date' => "Opening Date",
'due_date' => "Due Date",
- 'answer_date' => "Answer Date");
+ 'answer_date' => "Answer Date",
+ 'tries' => 'Number of Tries'
+ );
my %parmTypeHash = ('open_date' => "0_opendate",
'due_date' => "0_duedate",
- 'answer_date' => "0_answerdate");
+ 'answer_date' => "0_answerdate",
+ 'tries' => '0_maxtries' );
- my $result = "\n";