version 1.9, 2003/04/11 19:01:46
|
version 1.30, 2003/05/15 16:14:52
|
Line 84 Of course this does nothing. In order fo
|
Line 84 Of course this does nothing. In order fo
|
necessary to put actual elements into the wizard. Documentation for each |
necessary to put actual elements into the wizard. Documentation for each |
of these elements follows. |
of these elements follows. |
|
|
|
=head2 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 |
|
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. |
|
|
|
Creating a helper via code is more like issuing commands to create |
|
a helper then normal code writing. For instance, elements will automatically |
|
be added to the last state created, so it's important to create the |
|
states in the correct order. |
|
|
|
First, create a new helper: |
|
|
|
use Apache::lonhelper; |
|
|
|
my $helper = Apache::lonhelper::new->("Helper Title"); |
|
|
|
Next you'll need to manually add states to the helper: |
|
|
|
Apache::lonhelper::state->new("STATE_NAME", "State's Human Title"); |
|
|
|
You don't need to save a reference to it because all elements up until |
|
the next state creation will automatically be added to this state. |
|
|
|
Elements are created by populating the $paramHash in |
|
Apache::lonhelper::paramhash. To prevent namespace issues, retrieve |
|
a reference to that has with getParamHash: |
|
|
|
my $paramHash = Apache::lonhelper::getParamHash(); |
|
|
|
You will need to do this for each state you create. |
|
|
|
Populate the $paramHash with the parameters for the element you wish |
|
to add next; the easiest way to find out what those entries are is |
|
to read the code. Some common ones are 'variable' to record the variable |
|
to store the results in, and NEXTSTATE to record a next state transition. |
|
|
|
Then create your element: |
|
|
|
$paramHash->{MESSAGETEXT} = "This is a message."; |
|
Apache::lonhelper::message->new(); |
|
|
|
The creation will take the $paramHash and bless it into a |
|
Apache::lonhelper::message object. To create the next element, you need |
|
to get a reference to the new, empty $paramHash: |
|
|
|
$paramHash = Apache::lonhelper::getParamHash(); |
|
|
|
and you can repeat creating elements that way. You can add states |
|
and elements as needed. |
|
|
|
See lonprintout.pm, subroutine printHelper for an example of this, where |
|
we dynamically add some states to prevent security problems, for instance. |
|
|
|
Normally the machinery in the XML format is sufficient; dynamically |
|
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. |
|
|
|
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 |
|
imperative that you call B<Apache::lonhelper::registerHelperTags()> |
|
before parsing XML fragments and B<Apache::lonhelper::unregisterHelperTags()> |
|
when you are done. See lonprintout.pm for examples of this usage in the |
|
printHelper subroutine. |
|
|
=cut |
=cut |
|
|
package Apache::lonhelper; |
package Apache::lonhelper; |
Line 122 my $substate;
|
Line 193 my $substate;
|
# end of the element tag is located. |
# end of the element tag is located. |
my $paramHash; |
my $paramHash; |
|
|
|
# Note from Jeremy 5-8-2003: It is *vital* that the real handler be called |
|
# as a subroutine from the handler, or very mysterious things might happen. |
|
# I don't know exactly why, but it seems that the scope where the Apache |
|
# server enters the perl handler is treated differently from the rest of |
|
# the handler. This also seems to manifest itself in the debugger as entering |
|
# the perl handler in seemingly random places (sometimes it starts in the |
|
# compiling phase, sometimes in the handler execution phase where it runs |
|
# the code and stepping into the "1;" the module ends with goes into the handler, |
|
# sometimes starting directly with the handler); I think the cause is related. |
|
# 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 |
|
# 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 |
|
# 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 |
|
# everybody is happy. |
|
# The upshot of all of this is that for safety when a handler is using |
|
# file-scoped variables in LON-CAPA, the handler should be pushed down one |
|
# call level, as I do here, to ensure that the top-level handler function does |
|
# not get a different file scope from the rest of the code. |
sub handler { |
sub handler { |
my $r = shift; |
my $r = shift; |
$ENV{'request.uri'} = $r->uri(); |
return real_handler($r); |
my $filename = '/home/httpd/html' . $r->uri(); |
} |
|
|
|
# For debugging purposes, one can send a second parameter into this |
|
# function, the 'uri' of the helper you wish to have rendered, and |
|
# call this from other handlers. |
|
sub real_handler { |
|
my $r = shift; |
|
my $uri = shift; |
|
if (!defined($uri)) { $uri = $r->uri(); } |
|
$ENV{'request.uri'} = $uri; |
|
my $filename = '/home/httpd/html' . $uri; |
my $fh = Apache::File->new($filename); |
my $fh = Apache::File->new($filename); |
my $file; |
my $file; |
read $fh, $file, 100000000; |
read $fh, $file, 100000000; |
|
|
Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
|
|
|
# Send header, don't cache this page |
# Send header, don't cache this page |
if ($r->header_only) { |
if ($r->header_only) { |
Line 154 sub handler {
|
Line 257 sub handler {
|
# xml parsing |
# xml parsing |
&Apache::lonxml::xmlparse($r, 'helper', $file); |
&Apache::lonxml::xmlparse($r, 'helper', $file); |
|
|
|
$helper->process(); |
|
|
$r->print($helper->display()); |
$r->print($helper->display()); |
return OK; |
return OK; |
} |
} |
|
|
|
sub registerHelperTags { |
|
for my $tagList (@helperTags) { |
|
Apache::lonxml::register($tagList->[0], $tagList->[1]); |
|
} |
|
} |
|
|
|
sub unregisterHelperTags { |
|
for my $tagList (@helperTags) { |
|
Apache::lonxml::deregister($tagList->[0], $tagList->[1]); |
|
} |
|
} |
|
|
sub start_helper { |
sub start_helper { |
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
Line 165 sub start_helper {
|
Line 282 sub start_helper {
|
return ''; |
return ''; |
} |
} |
|
|
for my $tagList (@helperTags) { |
registerHelperTags(); |
Apache::lonxml::register($tagList->[0], $tagList->[1]); |
|
} |
Apache::lonhelper::helper->new($token->[2]{'title'}); |
|
|
$helper = Apache::lonhelper::helper->new($token->[2]{'title'}); |
|
return ''; |
return ''; |
} |
} |
|
|
Line 180 sub end_helper {
|
Line 295 sub end_helper {
|
return ''; |
return ''; |
} |
} |
|
|
for my $tagList (@helperTags) { |
unregisterHelperTags(); |
Apache::lonxml::deregister($tagList->[0], $tagList->[1]); |
|
} |
|
|
|
return ''; |
return ''; |
} |
} |
Line 194 sub start_state {
|
Line 307 sub start_state {
|
return ''; |
return ''; |
} |
} |
|
|
$state = Apache::lonhelper::state->new($token->[2]{'name'}, |
Apache::lonhelper::state->new($token->[2]{'name'}, |
$token->[2]{'title'}); |
$token->[2]{'title'}); |
return ''; |
return ''; |
} |
} |
|
|
|
# Use this to get the param hash from other files. |
|
sub getParamHash { |
|
return $paramHash; |
|
} |
|
|
|
# Use this to get the helper, if implementing elements in other files |
|
# (like lonprintout.pm) |
|
sub getHelper { |
|
return $helper; |
|
} |
|
|
# don't need this, so ignore it |
# don't need this, so ignore it |
sub end_state { |
sub end_state { |
return ''; |
return ''; |
Line 287 sub new {
|
Line 411 sub new {
|
# for an example. |
# for an example. |
$self->{DATA} = {}; |
$self->{DATA} = {}; |
|
|
|
$helper = $self; |
|
|
|
# Establish the $paramHash |
|
$paramHash = {}; |
|
|
bless($self, $class); |
bless($self, $class); |
return $self; |
return $self; |
} |
} |
Line 330 sub declareVar {
|
Line 459 sub declareVar {
|
|
|
my $envname = 'form.' . $var . '.forminput'; |
my $envname = 'form.' . $var . '.forminput'; |
if (defined($ENV{$envname})) { |
if (defined($ENV{$envname})) { |
$self->{VARS}->{$var} = $ENV{$envname}; |
if (ref($ENV{$envname})) { |
|
$self->{VARS}->{$var} = join('|||', @{$ENV{$envname}}); |
|
} else { |
|
$self->{VARS}->{$var} = $ENV{$envname}; |
|
} |
} |
} |
} |
} |
|
|
Line 347 sub registerState {
|
Line 480 sub registerState {
|
$self->{STATES}{$stateName} = $state; |
$self->{STATES}{$stateName} = $state; |
} |
} |
|
|
# Done in four phases |
sub process { |
# 1: Do the post processing for the previous state. |
|
# 2: Do the preprocessing for the current state. |
|
# 3: Check to see if state changed, if so, postprocess current and move to next. |
|
# Repeat until state stays stable. |
|
# 4: Render the current state to the screen as an HTML page. |
|
sub display { |
|
my $self = shift; |
my $self = shift; |
|
|
my $result = ""; |
|
|
|
# Phase 1: Post processing for state of previous screen (which is actually |
# 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 |
# the "current state" in terms of the helper variables), if it wasn't the |
# beginning state. |
# beginning state. |
if ($self->{STATE} ne "START" || $ENV{"form.SUBMIT"} eq "Next ->") { |
if ($self->{STATE} ne "START" || $ENV{"form.SUBMIT"} eq "Next ->") { |
my $prevState = $self->{STATES}{$self->{STATE}}; |
my $prevState = $self->{STATES}{$self->{STATE}}; |
$prevState->postprocess(); |
$prevState->postprocess(); |
} |
} |
|
|
# Note, to handle errors in a state's input that a user must correct, |
# Note, to handle errors in a state's input that a user must correct, |
Line 372 sub display {
|
Line 497 sub display {
|
|
|
# Phase 2: Preprocess current state |
# Phase 2: Preprocess current state |
my $startState = $self->{STATE}; |
my $startState = $self->{STATE}; |
my $state = $self->{STATES}{$startState}; |
my $state = $self->{STATES}->{$startState}; |
|
|
# Error checking; it is intended that the developer will have |
# For debugging, print something here to determine if you're going |
# checked all paths and the user can't see this! |
# to an undefined state. |
if (!defined($state)) { |
if (!defined($state)) { |
$result .="Error! The state ". $startState ." is not defined."; |
return; |
return $result; |
|
} |
} |
$state->preprocess(); |
$state->preprocess(); |
|
|
# Phase 3: While the current state is different from the previous state, |
# Phase 3: While the current state is different from the previous state, |
# keep processing. |
# keep processing. |
while ( $startState ne $self->{STATE} ) |
while ( $startState ne $self->{STATE} && |
|
defined($self->{STATES}->{$self->{STATE}}) ) |
{ |
{ |
$startState = $self->{STATE}; |
$startState = $self->{STATE}; |
$state = $self->{STATES}{$startState}; |
$state = $self->{STATES}->{$startState}; |
$state->preprocess(); |
$state->preprocess(); |
} |
} |
|
|
|
return; |
|
} |
|
|
|
# 1: Do the post processing for the previous state. |
|
# 2: Do the preprocessing for the current state. |
|
# 3: Check to see if state changed, if so, postprocess current and move to next. |
|
# Repeat until state stays stable. |
|
# 4: Render the current state to the screen as an HTML page. |
|
sub display { |
|
my $self = shift; |
|
|
|
my $state = $self->{STATES}{$self->{STATE}}; |
|
|
|
my $result = ""; |
|
|
|
if (!defined($state)) { |
|
$result = "<font color='#ff0000'>Error: state '$state' not defined!</font>"; |
|
return $result; |
|
} |
|
|
# Phase 4: Display. |
# Phase 4: Display. |
my $stateTitle = $state->title(); |
my $stateTitle = $state->title(); |
my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'',''); |
my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'',''); |
Line 402 sub display {
|
Line 547 sub display {
|
</head> |
</head> |
$bodytag |
$bodytag |
HEADER |
HEADER |
if (!$state->overrideForm()) { $result.="<form name='wizform' method='GET'>"; } |
if (!$state->overrideForm()) { $result.="<form name='helpform' method='POST'>"; } |
$result .= <<HEADER; |
$result .= <<HEADER; |
<table border="0"><tr><td> |
<table border="0"><tr><td> |
<h2><i>$stateTitle</i></h2> |
<h2><i>$stateTitle</i></h2> |
HEADER |
HEADER |
|
|
|
$result .= "<table><tr><td rowspan='2' valign='top'>"; |
|
|
if (!$state->overrideForm()) { |
if (!$state->overrideForm()) { |
$result .= $self->_saveVars(); |
$result .= $self->_saveVars(); |
} |
} |
$result .= $state->render() . "<p> </p>"; |
$result .= $state->render(); |
|
|
|
$result .= "</td><td valign='top'>"; |
|
|
|
# Warning: Copy and pasted from below, because it's too much trouble to |
|
# turn this into a subroutine |
if (!$state->overrideForm()) { |
if (!$state->overrideForm()) { |
$result .= '<center>'; |
$result .= '<center>'; |
if ($self->{STATE} ne $self->{START_STATE}) { |
if ($self->{STATE} ne $self->{START_STATE}) { |
Line 423 HEADER
|
Line 574 HEADER
|
$result .= "<a href=\"$returnPage\">End Helper</a>"; |
$result .= "<a href=\"$returnPage\">End Helper</a>"; |
} |
} |
else { |
else { |
$result .= '<input name="back" type="button" '; |
$result .= '<nobr><input name="back" type="button" '; |
$result .= 'value="<- Previous" onclick="history.go(-1)" /> '; |
$result .= 'value="<- Previous" onclick="history.go(-1)" /> '; |
$result .= '<input name="SUBMIT" type="submit" value="Next ->" />'; |
$result .= '<input name="SUBMIT" type="submit" value="Next ->" /></nobr> '; |
} |
} |
$result .= "</center>\n"; |
$result .= "</center>\n"; |
} |
} |
|
|
foreach my $key (keys %{$self->{VARS}}) { |
$result .= "</td></tr><tr><td valign='bottom'>"; |
$result .= "|$key| -> " . $self->{VARS}->{$key} . "<br />"; |
|
|
# Warning: Copy and pasted from above, because it's too much trouble to |
|
# turn this into a subroutine |
|
if (!$state->overrideForm()) { |
|
$result .= '<center>'; |
|
if ($self->{STATE} ne $self->{START_STATE}) { |
|
#$result .= '<input name="SUBMIT" type="submit" value="<- Previous" /> '; |
|
} |
|
if ($self->{DONE}) { |
|
my $returnPage = $self->{RETURN_PAGE}; |
|
$result .= "<a href=\"$returnPage\">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 .= "</center>\n"; |
} |
} |
|
|
|
#foreach my $key (keys %{$self->{VARS}}) { |
|
# $result .= "|$key| -> " . $self->{VARS}->{$key} . "<br />"; |
|
#} |
|
|
|
$result .= "</td></tr></table>"; |
|
|
$result .= <<FOOTER; |
$result .= <<FOOTER; |
</td> |
</td> |
</tr> |
</tr> |
Line 474 sub new {
|
Line 648 sub new {
|
|
|
$helper->registerState($self); |
$helper->registerState($self); |
|
|
|
$state = $self; |
|
|
return $self; |
return $self; |
} |
} |
|
|
Line 517 sub postprocess {
|
Line 693 sub postprocess {
|
} |
} |
} |
} |
|
|
|
# Override the form if any element wants to. |
|
# two elements overriding the form will make a mess, but that should |
|
# be considered helper author error ;-) |
sub overrideForm { |
sub overrideForm { |
|
my $self = shift; |
|
for my $element (@{$self->{ELEMENTS}}) { |
|
if ($element->overrideForm()) { |
|
return 1; |
|
} |
|
} |
return 0; |
return 0; |
} |
} |
|
|
Line 535 sub render {
|
Line 720 sub render {
|
for my $element (@{$self->{ELEMENTS}}) { |
for my $element (@{$self->{ELEMENTS}}) { |
push @results, $element->render(); |
push @results, $element->render(); |
} |
} |
|
|
return join("\n", @results); |
return join("\n", @results); |
} |
} |
|
|
Line 547 package Apache::lonhelper::element;
|
Line 733 package Apache::lonhelper::element;
|
|
|
=head2 Element Base Class |
=head2 Element Base Class |
|
|
The Apache::lonhelper::element base class provides support methods for |
The Apache::lonhelper::element base class provides support for elements |
the elements to use, such as a multiple value processer. |
and defines some generally useful tags for use in elements. |
|
|
B<Methods>: |
B<finalcode tag> |
|
|
=over 4 |
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;" |
=item * process_multiple_choices(formName, varName): Process the form |
and "}". It is expected to return a string describing what it did, which |
element named "formName" and place the selected items into the helper |
may be an empty string. See course initialization helper for an example. This is |
variable named varName. This is for things like checkboxes or |
generally intended for helpers like the course initialization helper, which consist |
multiple-selection listboxes where the user can select more then |
of several panels, each of which is performing some sort of bite-sized functionality. |
one entry. The selected entries are delimited by triple pipes in |
|
the helper variables, like this: |
B<defaultvalue tag> |
|
|
CHOICE_1|||CHOICE_2|||CHOICE_3 |
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 <choices> 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. |
|
|
=back |
Again, see the course initialization helper for examples. |
|
|
=cut |
=cut |
|
|
BEGIN { |
BEGIN { |
&Apache::lonhelper::register('Apache::lonhelper::element', |
&Apache::lonhelper::register('Apache::lonhelper::element', |
('nextstate')); |
('nextstate', 'finalcode', |
|
'defaultvalue')); |
} |
} |
|
|
# Because we use the param hash, this is often a sufficent |
# Because we use the param hash, this is often a sufficent |
Line 604 sub start_nextstate {
|
Line 802 sub start_nextstate {
|
|
|
sub end_nextstate { return ''; } |
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 preprocess { |
sub preprocess { |
return 1; |
return 1; |
} |
} |
Line 616 sub render {
|
Line 844 sub render {
|
return ''; |
return ''; |
} |
} |
|
|
sub process_multiple_choices { |
sub overrideForm { |
my $self = shift; |
return 0; |
my $formname = shift; |
|
my $var = shift; |
|
|
|
my $formvalue = $ENV{'form.' . $formname}; |
|
if ($formvalue) { |
|
# Must extract values from querystring 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; |
|
} |
} |
|
|
1; |
1; |
Line 680 use strict;
|
Line 887 use strict;
|
|
|
BEGIN { |
BEGIN { |
&Apache::lonhelper::register('Apache::lonhelper::message', |
&Apache::lonhelper::register('Apache::lonhelper::message', |
('message', 'message_text')); |
('message')); |
} |
} |
|
|
sub new { |
sub new { |
Line 690 sub new {
|
Line 897 sub new {
|
|
|
# CONSTRUCTION: Construct the message element from the XML |
# CONSTRUCTION: Construct the message element from the XML |
sub start_message { |
sub start_message { |
return ''; |
|
} |
|
|
|
sub end_message { |
|
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
if ($target ne 'helper') { |
if ($target ne 'helper') { |
return ''; |
return ''; |
} |
} |
Apache::lonhelper::message->new(); |
|
|
$paramHash->{MESSAGE_TEXT} = &Apache::lonxml::get_all_text('/message', |
|
$parser); |
|
|
|
if (defined($token->[2]{'nextstate'})) { |
|
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'}; |
|
} |
return ''; |
return ''; |
} |
} |
|
|
sub start_message_text { |
sub end_message { |
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
if ($target ne 'helper') { |
if ($target ne 'helper') { |
return ''; |
return ''; |
} |
} |
|
Apache::lonhelper::message->new(); |
$paramHash->{MESSAGE_TEXT} = &Apache::lonxml::get_all_text('/message_text', |
return ''; |
$parser); |
|
} |
} |
|
|
sub end_message_text { return 1; } |
|
|
|
sub render { |
sub render { |
my $self = shift; |
my $self = shift; |
Line 750 the result is stored in.
|
Line 956 the result is stored in.
|
<choices> takes an attribute "multichoice" which, if set to a true |
<choices> takes an attribute "multichoice" which, if set to a true |
value, will allow the user to select multiple choices. |
value, will allow the user to select multiple choices. |
|
|
|
<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<SUB-TAGS> |
B<SUB-TAGS> |
|
|
<choices> can have the following subtags: |
<choices> can have the following subtags: |
Line 767 B<SUB-TAGS>
|
Line 977 B<SUB-TAGS>
|
For example, |
For example, |
<choice computer='234-12-7312'>Bobby McDormik</choice>. |
<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> may optionally contain a 'nextstate' attribute, which |
<choice> may optionally contain a 'nextstate' attribute, which |
will be the state transisitoned to if the choice is made, if |
will be the state transisitoned to if the choice is made, if |
the choice is not multichoice. |
the choice is not multichoice. |
Line 794 You can mix and match methods of creatin
|
Line 1009 You can mix and match methods of creatin
|
"push" onto the choice list, rather then wiping it out. (You can even |
"push" onto the choice list, rather then wiping it out. (You can even |
remove choices programmatically, but that would probably be bad form.) |
remove choices programmatically, but that would probably be bad form.) |
|
|
|
B<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 |
|
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 <choices> |
|
tag is stored in the {VARS} hash. |
|
|
=cut |
=cut |
|
|
no strict; |
no strict; |
Line 819 sub start_choices {
|
Line 1046 sub start_choices {
|
} |
} |
|
|
# Need to initialize the choices list, so everything can assume it exists |
# 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'}); |
$helper->declareVar($paramHash->{'variable'}); |
$paramHash->{'multichoice'} = $token->[2]{'multichoice'}; |
$paramHash->{'multichoice'} = $token->[2]{'multichoice'}; |
|
$paramHash->{'allowempty'} = $token->[2]{'allowempty'}; |
$paramHash->{CHOICES} = []; |
$paramHash->{CHOICES} = []; |
return ''; |
return ''; |
} |
} |
Line 847 sub start_choice {
|
Line 1075 sub start_choice {
|
my $human = &Apache::lonxml::get_all_text('/choice', |
my $human = &Apache::lonxml::get_all_text('/choice', |
$parser); |
$parser); |
my $nextstate = $token->[2]{'nextstate'}; |
my $nextstate = $token->[2]{'nextstate'}; |
push @{$paramHash->{CHOICES}}, [$human, $computer, $nextstate]; |
my $evalFlag = $token->[2]{'eval'}; |
|
push @{$paramHash->{CHOICES}}, [$human, $computer, $nextstate, |
|
$evalFlag]; |
return ''; |
return ''; |
} |
} |
|
|
Line 865 sub render {
|
Line 1095 sub render {
|
if ($self->{'multichoice'}) { |
if ($self->{'multichoice'}) { |
$result .= <<SCRIPT; |
$result .= <<SCRIPT; |
<script> |
<script> |
function checkall(value) { |
function checkall(value, checkName) { |
for (i=0; i<document.forms.wizform.elements.length; i++) { |
for (i=0; i<document.forms.helpform.elements.length; i++) { |
document.forms.wizform.elements[i].checked=value; |
ele = document.forms.helpform.elements[i]; |
|
if (ele.name == checkName + '.forminput') { |
|
document.forms.helpform.elements[i].checked=value; |
|
} |
} |
} |
} |
} |
</script> |
</script> |
SCRIPT |
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 = <<BUTTONS; |
$buttons = <<BUTTONS; |
<br /> |
<br /> |
<input type="button" onclick="checkall(true)" value="Select All" /> |
<input type="button" onclick="checkall(true, '$var')" value="Select All" /> |
<input type="button" onclick="checkall(false)" value="Unselect All" /> |
<input type="button" onclick="checkall(false, '$var')" value="Unselect All" /> |
<br /> |
<br /> |
BUTTONS |
BUTTONS |
} |
} |
Line 888 BUTTONS
|
Line 1126 BUTTONS
|
|
|
$result .= "<table>\n\n"; |
$result .= "<table>\n\n"; |
|
|
|
my %checkedChoices; |
|
my $checkedChoicesFunc; |
|
|
|
if (defined($self->{DEFAULT_VALUE})) { |
|
$checkedChoicesFunc = eval ($self->{DEFAULT_VALUE}); |
|
die 'Error in default value code for variable ' . |
|
{'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"; |
my $type = "radio"; |
if ($self->{'multichoice'}) { $type = 'checkbox'; } |
if ($self->{'multichoice'}) { $type = 'checkbox'; } |
my $checked = 0; |
|
foreach my $choice (@{$self->{CHOICES}}) { |
foreach my $choice (@{$self->{CHOICES}}) { |
$result .= "<tr>\n<td width='20'> </td>\n"; |
$result .= "<tr>\n<td width='20'> </td>\n"; |
$result .= "<td valign='top'><input type='$type' name='$var.forminput'" |
$result .= "<td valign='top'><input type='$type' name='$var.forminput'" |
. "' value='" . |
. "' value='" . |
HTML::Entities::encode($choice->[1]) |
HTML::Entities::encode($choice->[1]) |
. "'"; |
. "'"; |
if (!$self->{'multichoice'} && !$checked) { |
if ($checkedChoices{$choice->[1]}) { |
$result .= " checked "; |
$result .= " checked "; |
$checked = 1; |
|
} |
} |
$result .= "/></td><td> " . $choice->[0] . "</td></tr>\n"; |
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 .= "/></td><td> " . $choiceLabel . "</td></tr>\n"; |
} |
} |
$result .= "</table>\n\n\n"; |
$result .= "</table>\n\n\n"; |
$result .= $buttons; |
$result .= $buttons; |
Line 915 sub postprocess {
|
Line 1194 sub postprocess {
|
my $self = shift; |
my $self = shift; |
my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'}; |
my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'}; |
|
|
if (!$chosenValue) { |
if (!defined($chosenValue) && !$self->{'allowempty'}) { |
$self->{ERROR_MSG} = "You must choose one or more choices to" . |
$self->{ERROR_MSG} = "You must choose one or more choices to" . |
" continue."; |
" continue."; |
return 0; |
return 0; |
} |
} |
|
|
if ($self->{'multichoice'}) { |
if (ref($chosenValue)) { |
$self->process_multiple_choices($self->{'variable'}.'.forminput', |
$helper->{VARS}->{$self->{'variable'}} = join('|||', @$chosenValue); |
$self->{'variable'}); |
|
} |
} |
|
|
if (defined($self->{NEXTSTATE})) { |
if (defined($self->{NEXTSTATE})) { |
Line 1166 the user can manipulate the folders.
|
Line 1444 the user can manipulate the folders.
|
|
|
<resource> takes the standard variable attribute to control what helper |
<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" attribute, |
which controls whether the user can select more then one resource. |
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. |
|
|
B<SUB-TAGS> |
B<SUB-TAGS> |
|
|
Line 1193 B<SUB-TAGS>
|
Line 1477 B<SUB-TAGS>
|
"}" returns a string representing what you want to have as the value. By |
"}" 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}). |
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. |
|
|
=back |
=back |
|
|
=cut |
=cut |
Line 1204 use strict;
|
Line 1491 use strict;
|
BEGIN { |
BEGIN { |
&Apache::lonhelper::register('Apache::lonhelper::resource', |
&Apache::lonhelper::register('Apache::lonhelper::resource', |
('resource', 'filterfunc', |
('resource', 'filterfunc', |
'choicefunc', 'valuefunc')); |
'choicefunc', 'valuefunc', |
|
'mapurl')); |
} |
} |
|
|
sub new { |
sub new { |
Line 1222 sub start_resource {
|
Line 1510 sub start_resource {
|
|
|
$paramHash->{'variable'} = $token->[2]{'variable'}; |
$paramHash->{'variable'} = $token->[2]{'variable'}; |
$helper->declareVar($paramHash->{'variable'}); |
$helper->declareVar($paramHash->{'variable'}); |
|
$paramHash->{'multichoice'} = $token->[2]{'multichoice'}; |
|
$paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'}; |
|
$paramHash->{'toponly'} = $token->[2]{'toponly'}; |
return ''; |
return ''; |
} |
} |
|
|
Line 1289 sub start_valuefunc {
|
Line 1580 sub start_valuefunc {
|
|
|
sub end_valuefunc { return ''; } |
sub end_valuefunc { return ''; } |
|
|
|
sub start_mapurl { |
|
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
|
if ($target ne 'helper') { |
|
return ''; |
|
} |
|
|
|
my $contents = Apache::lonxml::get_all_text('/mapurl', |
|
$parser); |
|
$paramHash->{MAP_URL} = $contents; |
|
} |
|
|
|
sub end_mapurl { return ''; } |
|
|
# A note, in case I don't get to this before I leave. |
# A note, in case I don't get to this before I leave. |
# If someone complains about the "Back" button returning them |
# If someone complains about the "Back" button returning them |
# to the previous folder state, instead of returning them to |
# to the previous folder state, instead of returning them to |
Line 1307 sub render {
|
Line 1612 sub render {
|
my $var = $self->{'variable'}; |
my $var = $self->{'variable'}; |
my $curVal = $helper->{VARS}->{$var}; |
my $curVal = $helper->{VARS}->{$var}; |
|
|
|
my $buttons = ''; |
|
|
|
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 Resources" /> |
|
<input type="button" onclick="checkall(false, '$var')" value="Unselect All Resources" /> |
|
<br /> |
|
BUTTONS |
|
} |
|
|
if (defined $self->{ERROR_MSG}) { |
if (defined $self->{ERROR_MSG}) { |
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />'; |
$result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />'; |
} |
} |
|
|
|
$result .= $buttons; |
|
|
my $filterFunc = $self->{FILTER_FUNC}; |
my $filterFunc = $self->{FILTER_FUNC}; |
my $choiceFunc = $self->{CHOICE_FUNC}; |
my $choiceFunc = $self->{CHOICE_FUNC}; |
my $valueFunc = $self->{VALUE_FUNC}; |
my $valueFunc = $self->{VALUE_FUNC}; |
|
my $mapUrl = $self->{MAP_URL}; |
|
my $multichoice = $self->{'multichoice'}; |
|
|
# Create the composite function that renders the column on the nav map |
# 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 |
# have to admit any language that lets me do this can't be all bad |
Line 1321 sub render {
|
Line 1653 sub render {
|
my $checked = 0; |
my $checked = 0; |
my $renderColFunc = sub { |
my $renderColFunc = sub { |
my ($resource, $part, $params) = @_; |
my ($resource, $part, $params) = @_; |
|
|
|
my $inputType; |
|
if ($multichoice) { $inputType = 'checkbox'; } |
|
else {$inputType = 'radio'; } |
|
|
if (!&$choiceFunc($resource)) { |
if (!&$choiceFunc($resource)) { |
return '<td> </td>'; |
return '<td> </td>'; |
} else { |
} else { |
my $col = "<td><input type='radio' name='${var}.forminput' "; |
my $col = "<td><input type='$inputType' name='${var}.forminput' "; |
if (!$checked) { |
if (!$checked && !$multichoice) { |
$col .= "checked "; |
$col .= "checked "; |
$checked = 1; |
$checked = 1; |
} |
} |
Line 1337 sub render {
|
Line 1673 sub render {
|
} |
} |
}; |
}; |
|
|
$ENV{'form.condition'} = 1; |
$ENV{'form.condition'} = !$self->{'toponly'}; |
$result .= |
$result .= |
&Apache::lonnavmaps::render( { 'cols' => [$renderColFunc, |
&Apache::lonnavmaps::render( { 'cols' => [$renderColFunc, |
Apache::lonnavmaps::resource()], |
Apache::lonnavmaps::resource()], |
'showParts' => 0, |
'showParts' => 0, |
'url' => $helper->{URL}, |
|
'filterFunc' => $filterFunc, |
'filterFunc' => $filterFunc, |
'resource_no_folder_link' => 1 } |
'resource_no_folder_link' => 1, |
|
'suppressEmptySequences' => $self->{'suppressEmptySequences'}, |
|
'iterator_map' => $mapUrl } |
); |
); |
|
|
|
$result .= $buttons; |
|
|
return $result; |
return $result; |
} |
} |
|
|
sub postprocess { |
sub postprocess { |
my $self = shift; |
my $self = shift; |
|
|
|
if ($self->{'multichoice'} && !$helper->{VARS}->{$self->{'variable'}}) { |
|
$self->{ERROR_MSG} = 'You must choose at least one resource to continue.'; |
|
return 0; |
|
} |
|
|
if (defined($self->{NEXTSTATE})) { |
if (defined($self->{NEXTSTATE})) { |
$helper->changeState($self->{NEXTSTATE}); |
$helper->changeState($self->{NEXTSTATE}); |
} |
} |
Line 1402 sub start_student {
|
Line 1747 sub start_student {
|
$paramHash->{'variable'} = $token->[2]{'variable'}; |
$paramHash->{'variable'} = $token->[2]{'variable'}; |
$helper->declareVar($paramHash->{'variable'}); |
$helper->declareVar($paramHash->{'variable'}); |
$paramHash->{'multichoice'} = $token->[2]{'multichoice'}; |
$paramHash->{'multichoice'} = $token->[2]{'multichoice'}; |
|
if (defined($token->[2]{'nextstate'})) { |
|
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'}; |
|
} |
|
|
} |
} |
|
|
sub end_student { |
sub end_student { |
Line 1417 sub render {
|
Line 1766 sub render {
|
my $self = shift; |
my $self = shift; |
my $result = ''; |
my $result = ''; |
my $buttons = ''; |
my $buttons = ''; |
|
my $var = $self->{'variable'}; |
|
|
if ($self->{'multichoice'}) { |
if ($self->{'multichoice'}) { |
$result = <<SCRIPT; |
$result = <<SCRIPT; |
<script> |
<script> |
function checkall(value) { |
function checkall(value, checkName) { |
for (i=0; i<document.forms.wizform.elements.length; i++) { |
for (i=0; i<document.forms.helpform.elements.length; i++) { |
document.forms.wizform.elements[i].checked=value; |
ele = document.forms.helpform.elements[i]; |
|
if (ele.name == checkName + '.forminput') { |
|
document.forms.helpform.elements[i].checked=value; |
|
} |
} |
} |
} |
} |
</script> |
</script> |
SCRIPT |
SCRIPT |
$buttons = <<BUTTONS; |
$buttons = <<BUTTONS; |
<br /> |
<br /> |
<input type="button" onclick="checkall(true)" value="Select All" /> |
<input type="button" onclick="checkall(true, '$var')" value="Select All Students" /> |
<input type="button" onclick="checkall(false)" value="Unselect All" /> |
<input type="button" onclick="checkall(false, '$var')" value="Unselect All Students" /> |
<br /> |
<br /> |
BUTTONS |
BUTTONS |
} |
} |
Line 1442 BUTTONS
|
Line 1795 BUTTONS
|
|
|
# Load up the students |
# Load up the students |
my $choices = &Apache::loncoursedata::get_classlist(); |
my $choices = &Apache::loncoursedata::get_classlist(); |
|
|
my @keys = keys %{$choices}; |
my @keys = keys %{$choices}; |
|
|
# Constants |
# Constants |
Line 1473 BUTTONS
|
Line 1825 BUTTONS
|
$checked = 1; |
$checked = 1; |
} |
} |
$result .= |
$result .= |
" value='" . HTML::Entities::encode($_) |
" value='" . HTML::Entities::encode($_ . ':' . $choices->{$_}->[$section]) |
. "' /></td><td>" |
. "' /></td><td>" |
. HTML::Entities::encode($choices->{$_}->[$fullname]) |
. HTML::Entities::encode($choices->{$_}->[$fullname]) |
. "</td><td align='center'>" |
. "</td><td align='center'>" |
Line 1497 sub postprocess {
|
Line 1849 sub postprocess {
|
return 0; |
return 0; |
} |
} |
|
|
if ($self->{'multichoice'}) { |
|
$self->process_multiple_choices($self->{'variable'}.'.forminput', |
|
$self->{'variable'}); |
|
} |
|
if (defined($self->{NEXTSTATE})) { |
if (defined($self->{NEXTSTATE})) { |
$helper->changeState($self->{NEXTSTATE}); |
$helper->changeState($self->{NEXTSTATE}); |
} |
} |
Line 1612 sub render {
|
Line 1960 sub render {
|
my $var = $self->{'variable'}; |
my $var = $self->{'variable'}; |
|
|
my $subdirFunc = eval('sub {' . $self->{'filechoice'} . '}'); |
my $subdirFunc = eval('sub {' . $self->{'filechoice'} . '}'); |
|
die 'Error in resource filter code for variable ' . |
|
{'variable'} . ', Perl said:' . $@ if $@; |
|
|
my $subdir = &$subdirFunc(); |
my $subdir = &$subdirFunc(); |
|
|
my $filterFunc = $self->{FILTER_FUNC}; |
my $filterFunc = $self->{FILTER_FUNC}; |
my $buttons = ''; |
my $buttons = ''; |
|
my $type = 'radio'; |
|
if ($self->{'multichoice'}) { |
|
$type = 'checkbox'; |
|
} |
|
|
if ($self->{'multichoice'}) { |
if ($self->{'multichoice'}) { |
$result = <<SCRIPT; |
$result = <<SCRIPT; |
<script> |
<script> |
function checkall(value) { |
function checkall(value, checkName) { |
for (i=0; i<document.forms.wizform.elements.length; i++) { |
for (i=0; i<document.forms.helpform.elements.length; i++) { |
ele = document.forms.wizform.elements[i]; |
ele = document.forms.helpform.elements[i]; |
if (ele.type == "checkbox") { |
if (ele.name == checkName + '.forminput') { |
document.forms.wizform.elements[i].checked=value; |
document.forms.helpform.elements[i].checked=value; |
|
} |
|
} |
|
} |
|
|
|
function checkallclass(value, className) { |
|
for (i=0; i<document.forms.helpform.elements.length; i++) { |
|
ele = document.forms.helpform.elements[i]; |
|
if (ele.type == "$type" && ele.onclick) { |
|
document.forms.helpform.elements[i].checked=value; |
} |
} |
} |
} |
} |
} |
</script> |
</script> |
SCRIPT |
SCRIPT |
my $buttons = <<BUTTONS; |
$buttons = <<BUTTONS; |
<br /> |
<br /> |
<input type="button" onclick="checkall(true)" value="Select All" /> |
<input type="button" onclick="checkall(true, '$var')" value="Select All Files" /> |
<input type="button" onclick="checkall(false)" value="Unselect All" /> |
<input type="button" onclick="checkall(false, '$var')" value="Unselect All Files" /> |
|
BUTTONS |
|
|
|
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" /> |
<br /> |
<br /> |
BUTTONS |
BUTTONS |
|
} |
} |
} |
|
|
# Get the list of files in this directory. |
# Get the list of files in this directory. |
Line 1657 BUTTONS
|
Line 2028 BUTTONS
|
$result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />'; |
$result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />'; |
} |
} |
|
|
$result .= '<table border="0" cellpadding="1" cellspacing="1">'; |
$result .= '<table border="0" cellpadding="2" cellspacing="0">'; |
|
|
# Keeps track if there are no choices, prints appropriate error |
# Keeps track if there are no choices, prints appropriate error |
# if there are none. |
# if there are none. |
my $choices = 0; |
my $choices = 0; |
my $type = 'radio'; |
|
if ($self->{'multichoice'}) { |
|
$type = 'checkbox'; |
|
} |
|
# Print each legitimate file choice. |
# Print each legitimate file choice. |
for my $file (@fileList) { |
for my $file (@fileList) { |
$file = (split(/&/, $file))[0]; |
$file = (split(/&/, $file))[0]; |
Line 1674 BUTTONS
|
Line 2041 BUTTONS
|
} |
} |
my $fileName = $subdir .'/'. $file; |
my $fileName = $subdir .'/'. $file; |
if (&$filterFunc($file)) { |
if (&$filterFunc($file)) { |
$result .= '<tr><td align="right">' . |
my $status; |
"<input type='$type' name='" . $var |
my $color; |
|
if ($helper->{VARS}->{'construction'}) { |
|
($status, $color) = @{fileState($subdir, $file)}; |
|
} else { |
|
$status = ''; |
|
$color = ''; |
|
} |
|
|
|
# Netscape 4 is stupid and there's nowhere to put the |
|
# information on the input tag that the file is Published, |
|
# Unpublished, etc. In *real* browsers we can just say |
|
# "class='Published'" and check the className attribute of |
|
# the input tag, but Netscape 4 is too stupid to understand |
|
# that attribute, and un-comprehended attributes are not |
|
# reflected into the object model. So instead, what I do |
|
# is either have or don't have an "onclick" handler that |
|
# does nothing, give Published files the onclick handler, and |
|
# have the checker scripts check for that. Stupid and clumsy, |
|
# and only gives us binary "yes/no" information (at least I |
|
# couldn't figure out how to reach into the event handler's |
|
# actual code to retreive a value), but it works well enough |
|
# here. |
|
|
|
my $onclick = ''; |
|
if ($status eq 'Published' && $helper->{VARS}->{'construction'}) { |
|
$onclick = 'onclick="a=1" '; |
|
} |
|
$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) { |
if (!$self->{'multichoice'} && $choices == 0) { |
$result .= ' checked'; |
$result .= ' checked'; |
} |
} |
$result .= "/></td><td>" . $file . "</td></tr>\n"; |
$result .= "/></td><td bgcolor='$color'>" . $file . |
|
"</td><td bgcolor='$color'>$status</td></tr>\n"; |
$choices++; |
$choices++; |
} |
} |
} |
} |
Line 1697 BUTTONS
|
Line 2093 BUTTONS
|
return $result; |
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 { |
sub postprocess { |
my $self = shift; |
my $self = shift; |
my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'}; |
my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'}; |
Line 1706 sub postprocess {
|
Line 2133 sub postprocess {
|
return 0; |
return 0; |
} |
} |
|
|
if ($self->{'multichoice'}) { |
|
$self->process_multiple_choices($self->{'variable'}.'.forminput', |
|
$self->{'variable'}); |
|
} |
|
if (defined($self->{NEXTSTATE})) { |
if (defined($self->{NEXTSTATE})) { |
$helper->changeState($self->{NEXTSTATE}); |
$helper->changeState($self->{NEXTSTATE}); |
} |
} |
Line 1719 sub postprocess {
|
Line 2142 sub postprocess {
|
|
|
1; |
1; |
|
|
|
package Apache::lonhelper::section; |
|
|
|
=pod |
|
|
|
=head2 Element: 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. |
|
|
|
=cut |
|
|
|
no strict; |
|
@ISA = ("Apache::lonhelper::choices"); |
|
use strict; |
|
|
|
BEGIN { |
|
&Apache::lonhelper::register('Apache::lonhelper::section', |
|
('section')); |
|
} |
|
|
|
sub new { |
|
my $ref = Apache::lonhelper::choices->new(); |
|
bless($ref); |
|
} |
|
|
|
sub start_section { |
|
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'}; |
|
if (defined($token->[2]{'nextstate'})) { |
|
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'}; |
|
} |
|
|
|
# Populate the CHOICES element |
|
my %choices; |
|
|
|
my $section = Apache::loncoursedata::CL_SECTION(); |
|
my $classlist = Apache::loncoursedata::get_classlist(); |
|
foreach (keys %$classlist) { |
|
my $sectionName = $classlist->{$_}->[$section]; |
|
if (!$sectionName) { |
|
$choices{"No section assigned"} = ""; |
|
} else { |
|
$choices{$sectionName} = $sectionName; |
|
} |
|
} |
|
|
|
for my $sectionName (sort(keys(%choices))) { |
|
|
|
push @{$paramHash->{CHOICES}}, [$sectionName, $sectionName]; |
|
} |
|
} |
|
|
|
sub end_section { |
|
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
|
if ($target ne 'helper') { |
|
return ''; |
|
} |
|
Apache::lonhelper::section->new(); |
|
} |
|
1; |
|
|
package Apache::lonhelper::general; |
package Apache::lonhelper::general; |
|
|
=pod |
=pod |
Line 1749 be able to call methods on it.
|
Line 2246 be able to call methods on it.
|
|
|
BEGIN { |
BEGIN { |
&Apache::lonhelper::register('Apache::lonhelper::general', |
&Apache::lonhelper::register('Apache::lonhelper::general', |
'exec', 'condition', 'clause'); |
'exec', 'condition', 'clause', |
|
'eval'); |
} |
} |
|
|
sub start_exec { |
sub start_exec { |
Line 1763 sub start_exec {
|
Line 2261 sub start_exec {
|
|
|
$code = eval ('sub { my $helper = shift; my $state = shift; ' . |
$code = eval ('sub { my $helper = shift; my $state = shift; ' . |
$code . "}"); |
$code . "}"); |
|
die 'Error in <exec>, Perl said: '. $@ if $@; |
&$code($helper, $paramHash); |
&$code($helper, $paramHash); |
} |
} |
|
|
Line 1800 sub start_clause {
|
Line 2299 sub start_clause {
|
my $clause = Apache::lonxml::get_all_text('/clause', $parser); |
my $clause = Apache::lonxml::get_all_text('/clause', $parser); |
$clause = eval('sub { my $helper = shift; my $state = shift; ' |
$clause = eval('sub { my $helper = shift; my $state = shift; ' |
. $clause . '}'); |
. $clause . '}'); |
|
die 'Error in clause of condition, Perl said: ' . $@ if $@; |
if (!&$clause($helper, $paramHash)) { |
if (!&$clause($helper, $paramHash)) { |
# Discard all text until the /condition. |
# Discard all text until the /condition. |
&Apache::lonxml::get_all_text('/condition', $parser); |
&Apache::lonxml::get_all_text('/condition', $parser); |
Line 1808 sub start_clause {
|
Line 2308 sub start_clause {
|
|
|
sub end_clause { return ''; } |
sub end_clause { return ''; } |
|
|
|
=pod |
|
|
|
=head2 General-purpose tag: <eval> |
|
|
|
The <eval> tag will be evaluated as a subroutine call passed in the |
|
current helper object and state hash as described in <condition> above, |
|
but is expected to return a string to be printed directly to the |
|
screen. This is useful for dynamically generating messages. |
|
|
|
=cut |
|
|
|
# This is basically a type of message. |
|
# Programmatically setting $paramHash->{NEXTSTATE} would work, though |
|
# it's probably bad form. |
|
|
|
sub start_eval { |
|
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
|
if ($target ne 'helper') { |
|
return ''; |
|
} |
|
|
|
my $program = Apache::lonxml::get_all_text('/eval', $parser); |
|
$program = eval('sub { my $helper = shift; my $state = shift; ' |
|
. $program . '}'); |
|
die 'Error in eval code, Perl said: ' . $@ if $@; |
|
$paramHash->{MESSAGE_TEXT} = &$program($helper, $paramHash); |
|
} |
|
|
|
sub end_eval { |
|
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
|
if ($target ne 'helper') { |
|
return ''; |
|
} |
|
|
|
Apache::lonhelper::message->new(); |
|
} |
|
|
|
1; |
|
|
|
package Apache::lonhelper::final; |
|
|
|
=pod |
|
|
|
=head2 Element: final |
|
|
|
<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> |
|
snippets and collecting the results. Finally, it takes the user out of the |
|
helper, going to a provided page. |
|
|
|
=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 { 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; ' . $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); |
|
if ($result) { |
|
push @results, $result; |
|
} |
|
} |
|
} |
|
} |
|
|
|
if (scalar(@results) == 0) { |
|
return ''; |
|
} |
|
|
|
my $result = "<ul>\n"; |
|
for my $re (@results) { |
|
$result .= ' <li>' . $re . "</li>\n"; |
|
} |
|
return $result . '</ul>'; |
|
} |
|
|
|
1; |
|
|
|
package Apache::lonhelper::parmwizfinal; |
|
|
|
# This is the final state for the parmwizard. 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 . |
|
|
|
no strict; |
|
@ISA = ('Apache::lonhelper::element'); |
|
use strict; |
|
|
|
BEGIN { |
|
&Apache::lonhelper::register('Apache::lonhelper::parmwizfinal', |
|
('parmwizfinal')); |
|
} |
|
|
|
use Time::localtime; |
|
|
|
sub new { |
|
my $ref = Apache::lonhelper::choices->new(); |
|
bless ($ref); |
|
} |
|
|
|
sub start_parmwizfinal { return ''; } |
|
|
|
sub end_parmwizfinal { |
|
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; |
|
|
|
if ($target ne 'helper') { |
|
return ''; |
|
} |
|
Apache::lonhelper::parmwizfinal->new(); |
|
} |
|
|
|
# Renders a form that, when submitted, will form the input to lonparmset.pm |
|
sub render { |
|
my $self = shift; |
|
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 %parmTypeHash = ('open_date' => "0_opendate", |
|
'due_date' => "0_duedate", |
|
'answer_date' => "0_answerdate"); |
|
|
|
my $affectedResourceId = ""; |
|
my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}}; |
|
my $level = ""; |
|
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 |
|
$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 $res = $navmap->getById($vars->{RESOURCE_ID}); |
|
my $title = $res->compTitle(); |
|
$symb = $res->symb(); |
|
$navmap->untieHashes(); |
|
$resourceString .= "<li>for the map named <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 $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; |
|
$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>'; |
|
|
|
# Print the type of manipulation: |
|
$result .= '<li>Setting the <b>' . $dateTypeHash{$vars->{ACTION_TYPE}} |
|
. "</b></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 |
|
$result .= "<input type='hidden' name='recent_date_end' " . |
|
"value='" . $vars->{PARM_DATE} . "' />\n"; |
|
$result .= "<input type='hidden' name='pres_value' " . |
|
"value='" . $vars->{PARM_DATE} . "' />\n"; |
|
$result .= "<input type='hidden' name='pres_type' " . |
|
"value='date_end' />\n"; |
|
} elsif ($vars->{ACTION_TYPE} eq 'open_date') { |
|
$result .= "<input type='hidden' name='recent_date_start' ". |
|
"value='" . $vars->{PARM_DATE} . "' />\n"; |
|
$result .= "<input type='hidden' name='pres_value' " . |
|
"value='" . $vars->{PARM_DATE} . "' />\n"; |
|
$result .= "<input type='hidden' name='pres_type' " . |
|
"value='date_start' />\n"; |
|
} |
|
|
|
$result .= $resourceString; |
|
|
|
# Print targets |
|
if ($vars->{TARGETS} eq 'course') { |
|
$result .= '<li>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>"; |
|
$level -= 3; |
|
$result .= "<input type='hidden' name='csec' value='" . |
|
HTML::Entities::encode($section) . "' />\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}; |
|
$result .= "<input type='hidden' name='uname' value='". |
|
HTML::Entities::encode($uname) . "' />\n"; |
|
$result .= "<input type='hidden' name='udom' value='". |
|
HTML::Entities::encode($udom) . "' />\n"; |
|
} |
|
|
|
# Print value |
|
$result .= "<li>to <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"; |
|
|
|
# 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"; |
|
|
|
return $result; |
|
} |
|
|
|
sub overrideForm { |
|
return 1; |
|
} |
|
|
1; |
1; |
|
|
__END__ |
__END__ |