loncom/interface/lonhelper.pm - diff

Return to lonhelper.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonhelper.pm between versions 1.38 and 1.105

version 1.38, 2003/06/17 14:21:22	version 1.105, 2005/07/07 04:12:01
Line 25	Line 25
#	#
# http://www.lon-capa.org/	# http://www.lon-capa.org/
#	#
# (Page Handler
#
# (.helper handler
#

=pod	=pod

=head1 lonhelper - HTML Helper framework for LON-CAPA	=head1 NAME

	lonhelper - implements helper framework

	=head1 SYNOPSIS

	lonhelper implements the helper framework for LON-CAPA, and provides
	many generally useful components for that framework.

Helpers, often known as "wizards", are well-established UI widgets that users	Helpers are little programs which present the user with a sequence of
	simple choices, instead of one monolithic multi-dimensional
	choice. They are also referred to as "wizards", "druids", and
	other potentially trademarked or semantically-loaded words.

	=head1 OVERVIEWX<lonhelper>

	Helpers are well-established UI widgets that users
feel comfortable with. It can take a complicated multidimensional problem the	feel comfortable with. It can take a complicated multidimensional problem the
user has and turn it into a series of bite-sized one-dimensional questions.	user has and turn it into a series of bite-sized one-dimensional questions.

Line 46 directory and having the .helper file ex	Line 56 directory and having the .helper file ex

All classes are in the Apache::lonhelper namespace.	All classes are in the Apache::lonhelper namespace.

=head2 lonhelper XML file format	=head1 lonhelper XML file formatX<lonhelper, XML file format>

A helper consists of a top-level <helper> tag which contains a series of states.	A helper consists of a top-level <helper> tag which contains a series of states.
Each state contains one or more state elements, which are what the user sees, like	Each state contains one or more state elements, which are what the user sees, like
Line 87 Of course this does nothing. In order fo	Line 97 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	=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 wizard (see lonprintout.pm),
writing the helper in XML would be too complicated, because of scope	writing the helper in XML would be too complicated, because of scope
Line 146 Normally the machinery in the XML format	Line 156 Normally the machinery in the XML format
adding states can easily be done by wrapping the state in a <condition>	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,	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	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	all of the information you need because of scoping issues, or would-be <exec> or
of the information used is persistent because would-be <exec> or	<eval> blocks using the {DATA} mechanism results in hard-to-read
<eval> blocks that using the {DATA} mechanism results in hard-to-read	and -maintain code. (See course.initialization.helper for a borderline
and -maintain code.	case.)

It is possible to do some of the work with an XML fragment parsed by	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	lonxml; again, see lonprintout.pm for an example. In that case it is
Line 158 before parsing XML fragments and B<Apach	Line 168 before parsing XML fragments and B<Apach
when you are done. See lonprintout.pm for examples of this usage in the	when you are done. See lonprintout.pm for examples of this usage in the
printHelper subroutine.	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	=cut

package Apache::lonhelper;	package Apache::lonhelper;
use Apache::Constants qw(:common);	use Apache::Constants qw(:common);
use Apache::File;	use Apache::File;
use Apache::lonxml;	use Apache::lonxml;
	use Apache::lonlocal;
	use Apache::lonnet;

# Register all the tags with the helper, so the helper can	# Register all the tags with the helper, so the helper can
# push and pop them	# push and pop them
Line 208 my $paramHash;	Line 227 my $paramHash;
# In the debugger, this means that breakpoints are ignored until you step into	# 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->	# 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	# 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 in the helper constructor, and one referenced by the handler on the
# "$helper->process()" line. The second was therefore never set, and was still	# "$helper->process()" line. Using the debugger, one could actually
	# see the two different $helper variables, as hashes at completely
	# different addresses. The second was therefore never set, and was still
# undefined when I tried to call process on it.	# undefined when I tried to call process on it.
# By pushing the "real handler" down into the "real scope", everybody except the	# 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	# actual handler function directly below this comment gets the same $helper and
Line 231 sub real_handler {	Line 252 sub real_handler {
my $r = shift;	my $r = shift;
my $uri = shift;	my $uri = shift;
if (!defined($uri)) { $uri = $r->uri(); }	if (!defined($uri)) { $uri = $r->uri(); }
$ENV{'request.uri'} = $uri;	$env{'request.uri'} = $uri;
my $filename = '/home/httpd/html' . $uri;	my $filename = '/home/httpd/html' . $uri;
my $fh = Apache::File->new($filename);	my $fh = Apache::File->new($filename);
my $file;	my $file;
Line 239 sub real_handler {	Line 260 sub real_handler {


# Send header, don't cache this page	# Send header, don't cache this page
if ($r->header_only) {	if ($env{'browser.mathml'}) {
if ($ENV{'browser.mathml'}) {	&Apache::loncommon::content_type($r,'text/xml');
$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');
} else {	} else {
$r->content_type('text/html');	&Apache::loncommon::content_type($r,'text/html');
}	}
$r->send_http_header;	$r->send_http_header;
	return OK if $r->header_only;
$r->rflush();	$r->rflush();

# Discard result, we just want the objects that get created by the	# Discard result, we just want the objects that get created by the
Line 262 sub real_handler {	Line 275 sub real_handler {

my $allowed = $helper->allowedCheck();	my $allowed = $helper->allowedCheck();
if (!$allowed) {	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.";	":0:0:Permission denied to access this helper.";
return HTTP_NOT_ACCEPTABLE;	return HTTP_NOT_ACCEPTABLE;
}	}
Line 343 sub end_state {	Line 356 sub end_state {
package Apache::lonhelper::helper;	package Apache::lonhelper::helper;

use Digest::MD5 qw(md5_hex);	use Digest::MD5 qw(md5_hex);
use HTML::Entities;	use HTML::Entities();
use Apache::loncommon;	use Apache::loncommon;
use Apache::File;	use Apache::File;
	use Apache::lonlocal;
	use Apache::lonnet;

sub new {	sub new {
my $proto = shift;	my $proto = shift;
Line 357 sub new {	Line 372 sub new {

# If there is a state from the previous form, use that. If there is no	# If there is a state from the previous form, use that. If there is no
# state, use the start state parameter.	# 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	else
{	{
$self->{STATE} = "START";	$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	# If a token was passed, we load that in. Otherwise, we need to create a
# new storage file	# new storage file
# Tried to use standard Tie'd hashes, but you can't seem to take a	# Tried to use standard Tie'd hashes, but you can't seem to take a
Line 399 sub new {	Line 414 sub new {
return undef;	return undef;
}	}
# Must create the storage	# 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());	time() . rand());
$self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN});	$self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN});
}	}

# OK, we now have our persistent storage.	# 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	else
{	{
Line 437 sub _saveVars {	Line 452 sub _saveVars {
my $self = shift;	my $self = shift;
my $result = "";	my $result = "";
$result .= '<input type="hidden" name="CURRENT_STATE" value="' .	$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="' .	$result .= '<input type="hidden" name="TOKEN" value="' .
$self->{TOKEN} . "\" />\n";	$self->{TOKEN} . "\" />\n";
$result .= '<input type="hidden" name="RETURN_PAGE" value="' .	$result .= '<input type="hidden" name="RETURN_PAGE" value="' .
HTML::Entities::encode($self->{RETURN_PAGE}) . "\" />\n";	HTML::Entities::encode($self->{RETURN_PAGE},'<>&"') . "\" />\n";

return $result;	return $result;
}	}
Line 469 sub declareVar {	Line 484 sub declareVar {
}	}

my $envname = 'form.' . $var . '.forminput';	my $envname = 'form.' . $var . '.forminput';
if (defined($ENV{$envname})) {	if (defined($env{$envname})) {
if (ref($ENV{$envname})) {	if (ref($env{$envname})) {
$self->{VARS}->{$var} = join('\|\|\|', @{$ENV{$envname}});	$self->{VARS}->{$var} = join('\|\|\|', @{$env{$envname}});
} else {	} else {
$self->{VARS}->{$var} = $ENV{$envname};	$self->{VARS}->{$var} = $env{$envname};
}	}
}	}
}	}
Line 485 sub allowedCheck {	Line 500 sub allowedCheck {
return 1;	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 {	sub changeState {
Line 507 sub process {	Line 522 sub process {
# 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 &mt("Next ->")) {
my $prevState = $self->{STATES}{$self->{STATE}};	my $prevState = $self->{STATES}{$self->{STATE}};
$prevState->postprocess();	$prevState->postprocess();
}	}
Line 558 sub display {	Line 573 sub display {
}	}

# Phase 4: Display.	# Phase 4: Display.
my $stateTitle = $state->title();	my $html=&Apache::lonxml::xmlbegin();
my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'','');	my $stateTitle=&mt($state->title());
	my $helperTitle = &mt($self->{TITLE});
	my $bodytag = &Apache::loncommon::bodytag($helperTitle,'','');
	my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
	my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
	# FIXME: This should be parameterized, not concatenated - Jeremy
	my $loncapaHelper = &mt("LON-CAPA Helper:");

$result .= <<HEADER;	$result .= <<HEADER;
<html>	$html
<head>	<head>
<title>LON-CAPA Helper: $self->{TITLE}</title>	<title>$loncapaHelper: $helperTitle</title>
</head>	</head>
$bodytag	$bodytag
HEADER	HEADER
Line 591 HEADER	Line 612 HEADER
}	}
if ($self->{DONE}) {	if ($self->{DONE}) {
my $returnPage = $self->{RETURN_PAGE};	my $returnPage = $self->{RETURN_PAGE};
$result .= "<a href=\"$returnPage\">End Helper</a>";	$result .= "<a href=\"$returnPage\">" . &mt("End Helper") . "</a>";
}	}
else {	else {
$result .= '<nobr><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 ->" /></nobr>';	$result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
}	}
}	}

Line 610 HEADER	Line 631 HEADER
}	}
if ($self->{DONE}) {	if ($self->{DONE}) {
my $returnPage = $self->{RETURN_PAGE};	my $returnPage = $self->{RETURN_PAGE};
$result .= "<a href=\"$returnPage\">End Helper</a>";	$result .= "<a href=\"$returnPage\">" . &mt('End Helper') . "</a>";
}	}
else {	else {
$result .= '<nobr><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 ->" /></nobr>';	$result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
}	}
}	}

Line 748 package Apache::lonhelper::element;	Line 769 package Apache::lonhelper::element;

=pod	=pod

=head2 Element Base Class	=head1 Element Base Class

The Apache::lonhelper::element base class provides support for elements	The Apache::lonhelper::element base class provides support for elements
and defines some generally useful tags for use in elements.	and defines some generally useful tags for use in elements.

B<finalcode tag>	=head2 finalcode tagX<finalcode>

Each element can contain a "finalcode" tag that, when the special FINAL	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;"	helper state is used, will be executed, surrounded by "sub { my $helper = shift;"
Line 762 may be an empty string. See course initi	Line 783 may be an empty string. See course initi
generally intended for helpers like the course initialization helper, which consist	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.	of several panels, each of which is performing some sort of bite-sized functionality.

B<defaultvalue tag>	=head2 defaultvalue tagX<defaultvalue>

Each element that accepts user input can contain a "defaultvalue" tag that,	Each element that accepts user input can contain a "defaultvalue" tag that,
when surrounded by "sub { my $helper = shift; my $state = shift; " and "}",	when surrounded by "sub { my $helper = shift; my $state = shift; " and "}",
Line 779 some setting accidentally.	Line 800 some setting accidentally.

Again, see the course initialization helper for examples.	Again, see the course initialization helper for examples.

B<validator tag>	=head2 validator tagX<validator>

Some elements that accepts user input can contain a "validator" tag that,	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 "	when surrounded by "sub { my $helper = shift; my $state = shift; my $element = shift; my $val = shift "
Line 791 will return an error message to be displ	Line 812 will return an error message to be displ
Consult the documentation for each element to see whether it supports this	Consult the documentation for each element to see whether it supports this
tag.	tag.

B<getValue method>	=head2 getValue methodX<getValue (helper elements)>

If the element stores the name of the variable in a 'variable' member, which	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	the provided ones all do, you can retreive the value of the variable by calling
Line 867 sub start_defaultvalue {	Line 888 sub start_defaultvalue {

sub end_defaultvalue { return ''; }	sub end_defaultvalue { return ''; }

	# Validators may need to take language specifications
sub start_validator {	sub start_validator {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;	my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;

Line 910 package Apache::lonhelper::message;	Line 932 package Apache::lonhelper::message;

=pod	=pod

=head2 Element: message	=head1 Elements

	=head2 Element: messageX<message, helper element>

Message elements display the contents of their <message_text> tags, and	Message elements display their contents, and
transition directly to the state in the <nextstate> tag. Example:	transition directly to the state in the <nextstate> attribute. Example:

<message>	<message nextstate='GET_NAME'>
<nextstate>GET_NAME</nextstate>	This is the <b>message</b> the user will see,
<message_text>This is the <b>message</b> the user will see,	<i>HTML allowed</i>.
<i>HTML allowed</i>.</message_text>
</message>	</message>

This will display the HTML message and transition to the <nextstate> if	This will display the HTML message and transition to the 'nextstate' if
given. The HTML will be directly inserted into the helper, so if you don't	given. The HTML will be directly inserted into the helper, so if you don't
want text to run together, you'll need to manually wrap the <message_text>	want text to run together, you'll need to manually wrap the message text
in <p> tags, or whatever is appropriate for your HTML.	in <p> tags, or whatever is appropriate for your HTML.

Message tags do not add in whitespace, so if you want it, you'll need to add	Message tags do not add in whitespace, so if you want it, you'll need to add
Line 935 within each other.)	Line 958 within each other.)
This is also a good template for creating your own new states, as it has	This is also a good template for creating your own new states, as it has
very little code beyond the state template.	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	=cut

no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::message',	&Apache::lonhelper::register('Apache::lonhelper::message',
Line 959 sub start_message {	Line 988 sub start_message {
return '';	return '';
}	}

$paramHash->{MESSAGE_TEXT} = &Apache::lonxml::get_all_text('/message',	$paramHash->{MESSAGE_TEXT} = &mtn(&Apache::lonxml::get_all_text('/message',
$parser);	$parser));

if (defined($token->[2]{'nextstate'})) {	if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};	$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
Line 981 sub end_message {	Line 1010 sub end_message {
sub render {	sub render {
my $self = shift;	my $self = shift;

return $self->{MESSAGE_TEXT};	return &mtn($self->{MESSAGE_TEXT});
}	}
# If a NEXTSTATE was given, switch to it	# If a NEXTSTATE was given, switch to it
sub postprocess {	sub postprocess {
Line 998 package Apache::lonhelper::choices;	Line 1027 package Apache::lonhelper::choices;

=pod	=pod

=head2 Element: choices	=head2 Element: choicesX<choices, helper element>

Choice states provide a single choice to the user as a text selection box.	Choice states provide a single choice to the user as a text selection box.
A "choice" is two pieces of text, one which will be displayed to the user	A "choice" is two pieces of text, one which will be displayed to the user
Line 1016 value, will allow the user to select mul	Line 1045 value, will allow the user to select mul
value, will allow the user to select none of the choices without raising	value, will allow the user to select none of the choices without raising
an error message.	an error message.

B<SUB-TAGS>	=head3 SUB-TAGS

<choices> can have the following subtags:	<choices> can have the following subtags:X<choice, helper tag>

=over 4	=over 4

=item * <nextstate>state_name</nextstate>: If given, this will cause the	=item * <nextstate>state_name</nextstate>: If given, this will cause the
choice element to transition to the given state after executing. If	choice element to transition to the given state after executing.
this is used, do not pass nextstates to the <choice> tag.	This will override the <nextstate> passed to <choices> (if any).

=item * <choice />: If the choices are static,	=item * <choice />: If the choices are static,
this element will allow you to specify them. Each choice	this element will allow you to specify them. Each choice
Line 1033 B<SUB-TAGS>	Line 1062 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	<choice> can take a parameter "eval", which if set to
a true value, will cause the contents of the tag to be	a true value, will cause the contents of the tag to be
evaluated as it would be in an <eval> tag; see <eval> tag	evaluated as it would be in an <eval> tag; see <eval> tag
below.	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 transistioned to if the choice is made, if
the choice is not multichoice.	the choice is not multichoice. This will override the nextstate
	passed to the parent C<choices> tag.

=back	=back

Line 1065 You can mix and match methods of creatin	Line 1095 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>	=head3 defaultvalue support

Choices supports default values both in multichoice and single choice mode.	Choices supports default values both in multichoice and single choice mode.
In single choice mode, have the defaultvalue tag's function return the	In single choice mode, have the defaultvalue tag's function return the
Line 1082 tag is stored in the {VARS} hash.	Line 1112 tag is stored in the {VARS} hash.
no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal;
	use Apache::lonnet;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::choices',	&Apache::lonhelper::register('Apache::lonhelper::choices',
Line 1128 sub start_choice {	Line 1160 sub start_choice {
}	}

my $computer = $token->[2]{'computer'};	my $computer = $token->[2]{'computer'};
my $human = &Apache::lonxml::get_all_text('/choice',	my $human = &mt(&Apache::lonxml::get_all_text('/choice',
$parser);	$parser));
my $nextstate = $token->[2]{'nextstate'};	my $nextstate = $token->[2]{'nextstate'};
my $evalFlag = $token->[2]{'eval'};	my $evalFlag = $token->[2]{'eval'};
push @{$paramHash->{CHOICES}}, [$human, $computer, $nextstate,	push @{$paramHash->{CHOICES}}, [&mtn($human), $computer, $nextstate,
$evalFlag];	$evalFlag];
return '';	return '';
}	}
Line 1141 sub end_choice {	Line 1173 sub end_choice {
return '';	return '';
}	}

	{
	# used to generate unique id attributes for <input> tags.
	# internal use only.
	my $id = 0;
	sub new_id { return $id++; }
	}

sub render {	sub render {
# START HERE: Replace this with correct choices code.
my $self = shift;	my $self = shift;
my $var = $self->{'variable'};	my $var = $self->{'variable'};
my $buttons = '';	my $buttons = '';
Line 1166 SCRIPT	Line 1204 SCRIPT
# Only print "select all" and "unselect all" if there are five or	# Only print "select all" and "unselect all" if there are five or
# more choices; fewer then that and it looks silly.	# more choices; fewer then that and it looks silly.
if ($self->{'multichoice'} && scalar(@{$self->{CHOICES}}) > 4) {	if ($self->{'multichoice'} && scalar(@{$self->{CHOICES}}) > 4) {
	my %lt=&Apache::lonlocal::texthash(
	'sa' => "Select All",
	'ua' => "Unselect All");
$buttons = <<BUTTONS;	$buttons = <<BUTTONS;
<br />	<br />
<input type="button" onclick="checkall(true, '$var')" value="Select All" />	<input type="button" onclick="checkall(true, '$var')" value="$lt{'sa'}" />
<input type="button" onclick="checkall(false, '$var')" value="Unselect All" />	<input type="button" onclick="checkall(false, '$var')" value="$lt{'ua'}" />
<br />	<br />
BUTTONS	BUTTONS
}	}
Line 1221 BUTTONS	Line 1262 BUTTONS
my $type = "radio";	my $type = "radio";
if ($self->{'multichoice'}) { $type = 'checkbox'; }	if ($self->{'multichoice'}) { $type = 'checkbox'; }
foreach my $choice (@{$self->{CHOICES}}) {	foreach my $choice (@{$self->{CHOICES}}) {
	my $id = &new_id();
$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 ($checkedChoices{$choice->[1]}) {	if ($checkedChoices{$choice->[1]}) {
$result .= " checked ";	$result .= " checked ";
}	}
	$result .= qq{id="$id"};
my $choiceLabel = $choice->[0];	my $choiceLabel = $choice->[0];
if ($choice->[4]) { # if we need to evaluate this choice	if ($choice->[4]) { # if we need to evaluate this choice
$choiceLabel = "sub { my $helper = shift; my $state = shift;" .	$choiceLabel = "sub { my $helper = shift; my $state = shift;" .
Line 1236 BUTTONS	Line 1279 BUTTONS
$choiceLabel = eval($choiceLabel);	$choiceLabel = eval($choiceLabel);
$choiceLabel = &$choiceLabel($helper, $self);	$choiceLabel = &$choiceLabel($helper, $self);
}	}
$result .= "/></td><td> " . $choiceLabel . "</td></tr>\n";	$result .= "/></td><td> ".qq{<label for="$id">}.
	$choiceLabel. "</label></td></tr>\n";
}	}
$result .= "</table>\n\n\n";	$result .= "</table>\n\n\n";
$result .= $buttons;	$result .= $buttons;
Line 1248 BUTTONS	Line 1292 BUTTONS
# given, switch to it	# given, switch to it
sub postprocess {	sub postprocess {
my $self = shift;	my $self = shift;
my $chosenValue = $ENV{'form.' . $self->{'variable'} . '.forminput'};	my $chosenValue = $env{'form.' . $self->{'variable'} . '.forminput'};

if (!defined($chosenValue) && !$self->{'allowempty'}) {	if (!defined($chosenValue) && !$self->{'allowempty'}) {
$self->{ERROR_MSG} = "You must choose one or more choices to" .	$self->{ERROR_MSG} =
" continue.";	&mt("You must choose one or more choices to continue.");
return 0;	return 0;
}	}

Line 1275 sub postprocess {	Line 1319 sub postprocess {
}	}
1;	1;

	package Apache::lonhelper::dropdown;

	=pod

	=head2 Element: dropdownX<dropdown, helper tag>

	A drop-down provides a drop-down box instead of a radio button
	box. Because most people do not know how to use a multi-select
	drop-down box, that option is not allowed. Otherwise, the arguments
	are the same as "choices", except "allowempty" is also meaningless.

	<dropdown> takes an attribute "variable" to control which helper variable
	the result is stored in.

	=head3 SUB-TAGS

	<choice>, which acts just as it does in the "choices" element.

	=cut

	# This really ought to be a sibling class to "choice" which is itself
	# a child of some abstract class.... shrug

	no strict;
	@ISA = ("Apache::lonhelper::element");
	use strict;
	use Apache::lonlocal;
	use Apache::lonnet;

	BEGIN {
	&Apache::lonhelper::register('Apache::lonhelper::dropdown',
	('dropdown'));
	}

	sub new {
	my $ref = Apache::lonhelper::element->new();
	bless($ref);
	}

	# CONSTRUCTION: Construct the message element from the XML
	sub start_dropdown {
	my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;

	if ($target ne 'helper') {
	return '';
	}

	# Need to initialize the choices list, so everything can assume it exists
	$paramHash->{'variable'} = $token->[2]{'variable'} if (!defined($paramHash->{'variable'}));
	$helper->declareVar($paramHash->{'variable'});
	$paramHash->{CHOICES} = [];
	return '';
	}

	sub end_dropdown {
	my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;

	if ($target ne 'helper') {
	return '';
	}
	Apache::lonhelper::dropdown->new();
	return '';
	}

	sub render {
	my $self = shift;
	my $var = $self->{'variable'};
	my $result = '';

	if (defined $self->{ERROR_MSG}) {
	$result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br />';
	}

	my %checkedChoices;
	my $checkedChoicesFunc;

	if (defined($self->{DEFAULT_VALUE})) {
	$checkedChoicesFunc = eval ($self->{DEFAULT_VALUE});
	die 'Error in default value code for variable ' .
	$self->{'variable'} . ', Perl said: ' . $@ if $@;
	} else {
	$checkedChoicesFunc = sub { return ''; };
	}

	# single choice
	my $selectedChoice = &$checkedChoicesFunc($helper, $self);

	my $foundChoice = 0;

	# check that the choice is in the list of choices.
	for my $choice (@{$self->{CHOICES}}) {
	if ($choice->[1] eq $selectedChoice) {
	$checkedChoices{$choice->[1]} = 1;
	$foundChoice = 1;
	}
	}

	# If we couldn't find the choice, pick the first one
	if (!$foundChoice) {
	$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
	}

	$result .= "<select name='${var}.forminput'>\n";
	foreach my $choice (@{$self->{CHOICES}}) {
	$result .= "<option value='" .
	HTML::Entities::encode($choice->[1],"<>&\"'")
	. "'";
	if ($checkedChoices{$choice->[1]}) {
	$result .= " selected";
	}
	my $choiceLabel = $choice->[0];
	if ($choice->[4]) { # if we need to evaluate this choice
	$choiceLabel = "sub { my $helper = shift; my $state = shift;" .
	$choiceLabel . "}";
	$choiceLabel = eval($choiceLabel);
	$choiceLabel = &$choiceLabel($helper, $self);
	}
	$result .= ">" . &mtn($choiceLabel) . "\n";
	}
	$result .= "</select>\n";

	return $result;
	}

	# If a NEXTSTATE was given or a nextstate for this choice was
	# given, switch to it
	sub postprocess {
	my $self = shift;
	my $chosenValue = $env{'form.' . $self->{'variable'} . '.forminput'};

	if (!defined($chosenValue) && !$self->{'allowempty'}) {
	$self->{ERROR_MSG} = "You must choose one or more choices to" .
	" continue.";
	return 0;
	}

	if (defined($self->{NEXTSTATE})) {
	$helper->changeState($self->{NEXTSTATE});
	}

	foreach my $choice (@{$self->{CHOICES}}) {
	if ($choice->[1] eq $chosenValue) {
	if (defined($choice->[2])) {
	$helper->changeState($choice->[2]);
	}
	}
	}
	return 1;
	}
	1;

package Apache::lonhelper::date;	package Apache::lonhelper::date;

=pod	=pod

=head2 Element: date	=head2 Element: dateX<date, helper element>

Date elements allow the selection of a date with a drop down list.	Date elements allow the selection of a date with a drop down list.

Line 1310 Example:	Line 1505 Example:
no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal; # A localization nightmare
	use Apache::lonnet;
use Time::localtime;	use Time::localtime;

BEGIN {	BEGIN {
Line 1374 sub render {	Line 1570 sub render {
} else {	} else {
$result .= "<option value='$i'>";	$result .= "<option value='$i'>";
}	}
$result .= $months[$i] . "</option>\n";	$result .= &mt($months[$i]) . "</option>\n";
}	}
$result .= "</select>\n";	$result .= "</select>\n";

Line 1404 sub render {	Line 1600 sub render {

# Display Hours and Minutes if they are called for	# Display Hours and Minutes if they are called for
if ($self->{'hoursminutes'}) {	if ($self->{'hoursminutes'}) {
	# This needs parameterization for times.
	my $am = &mt('a.m.');
	my $pm = &mt('p.m.');
# Build hour	# Build hour
$result .= "<select name='${var}hour'>\n";	$result .= "<select name='${var}hour'>\n";
$result .= "<option " . ($date->hour == 0 ? 'selected ':'') .	$result .= "<option " . ($date->hour == 0 ? 'selected ':'') .
" value='0'>midnight</option>\n";	" value='0'>" . &mt('midnight') . "</option>\n";
for ($i = 1; $i < 12; $i++) {	for ($i = 1; $i < 12; $i++) {
if ($date->hour == $i) {	if ($date->hour == $i) {
$result .= "<option selected value='$i'>$i a.m.</option>\n";	$result .= "<option selected value='$i'>$i $am</option>\n";
} else {	} else {
$result .= "<option value='$i'>$i a.m</option>\n";	$result .= "<option value='$i'>$i $am</option>\n";
}	}
}	}
$result .= "<option " . ($date->hour == 12 ? 'selected ':'') .	$result .= "<option " . ($date->hour == 12 ? 'selected ':'') .
" value='12'>noon</option>\n";	" value='12'>" . &mt('noon') . "</option>\n";
for ($i = 13; $i < 24; $i++) {	for ($i = 13; $i < 24; $i++) {
my $printedHour = $i - 12;	my $printedHour = $i - 12;
if ($date->hour == $i) {	if ($date->hour == $i) {
$result .= "<option selected value='$i'>$printedHour p.m.</option>\n";	$result .= "<option selected value='$i'>$printedHour $pm</option>\n";
} else {	} else {
$result .= "<option value='$i'>$printedHour p.m.</option>\n";	$result .= "<option value='$i'>$printedHour $pm</option>\n";
}	}
}	}

Line 1451 sub render {	Line 1650 sub render {
sub postprocess {	sub postprocess {
my $self = shift;	my $self = shift;
my $var = $self->{'variable'};	my $var = $self->{'variable'};
my $month = $ENV{'form.' . $var . 'month'};	my $month = $env{'form.' . $var . 'month'};
my $day = $ENV{'form.' . $var . 'day'};	my $day = $env{'form.' . $var . 'day'};
my $year = $ENV{'form.' . $var . 'year'};	my $year = $env{'form.' . $var . 'year'};
my $min = 0;	my $min = 0;
my $hour = 0;	my $hour = 0;
if ($self->{'hoursminutes'}) {	if ($self->{'hoursminutes'}) {
$min = $ENV{'form.' . $var . 'minute'};	$min = $env{'form.' . $var . 'minute'};
$hour = $ENV{'form.' . $var . 'hour'};	$hour = $env{'form.' . $var . 'hour'};
}	}

my $chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);	my $chosenDate;
	eval {$chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);};
	my $error = $@;

# Check to make sure that the date was not automatically co-erced into a	# 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	# 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	# This happens for "Feb. 31", for instance, which is coerced to March 2 or
# 3, depending on if it's a leapyear	# 3, depending on if it's a leap year
my $checkDate = localtime($chosenDate);	my $checkDate = localtime($chosenDate);

if ($checkDate->mon != $month \|\| $checkDate->mday != $day \|\|	if ($error \|\| $checkDate->mon != $month \|\| $checkDate->mday != $day \|\|
$checkDate->year + 1900 != $year) {	$checkDate->year + 1900 != $year) {
	unless (Apache::lonlocal::current_language()== ~/^en/) {
	$self->{ERROR_MSG} = &mt("Invalid date entry");
	return 0;
	}
	# LOCALIZATION FIXME: Needs to be parameterized
$self->{ERROR_MSG} = "Can't use " . $months[$month] . " $day, $year as a "	$self->{ERROR_MSG} = "Can't use " . $months[$month] . " $day, $year as a "
. "date because it doesn't exist. Please enter a valid date.";	. "date because it doesn't exist. Please enter a valid date.";

return 0;	return 0;
}	}

Line 1489 package Apache::lonhelper::resource;	Line 1697 package Apache::lonhelper::resource;

=pod	=pod

=head2 Element: resource	=head2 Element: resourceX<resource, helper element>

<resource> elements allow the user to select one or multiple resources	<resource> elements allow the user to select one or multiple resources
from the current course. You can filter out which resources they can view,	from the current course. You can filter out which resources they can view,
Line 1499 selections across folder openings and cl	Line 1707 selections across folder openings and cl
the user can manipulate the folders.	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"X<multichoice> attribute,
which controls whether the user can select more then one resource. The	which controls whether the user can select more then one resource. The
"toponly" attribute controls whether the resource display shows just the	"toponly" attribute controls whether the resource display shows just the
resources in that sequence, or recurses into all sub-sequences, defaulting	resources in that sequence, or recurses into all sub-sequences, defaulting
to false. The "suppressEmptySequences" attribute reflects the	to false. The "suppressEmptySequences" attribute reflects the
suppressEmptySequences argument to the render routine, which will cause	suppressEmptySequences argument to the render routine, which will cause
folders that have all of their contained resources filtered out to also	folders that have all of their contained resources filtered out to also
be filtered out.	be filtered out. The 'addstatus' attribute, if true, will add the icon
	and long status display columns to the display. The 'addparts'
	attribute will add in a part selector beside problems that have more
	than 1 part.

B<SUB-TAGS>	=head3 SUB-TAGS

=over 4	=over 4

=item * <filterfunc>: If you want to filter what resources are displayed	=item * <filterfunc>X<filterfunc>: If you want to filter what resources are displayed
to the user, use a filter func. The <filterfunc> tag should contain	to the user, use a filter func. The <filterfunc> tag should contain
Perl code that when wrapped with "sub { my $res = shift; " and "}" is	Perl code that when wrapped with "sub { my $res = shift; " and "}" is
a function that returns true if the resource should be displayed,	a function that returns true if the resource should be displayed,
Line 1520 B<SUB-TAGS>	Line 1731 B<SUB-TAGS>
(See Apache::lonnavmaps documentation for information about the	(See Apache::lonnavmaps documentation for information about the
resource object.)	resource object.)

=item * <choicefunc>: Same as <filterfunc>, except that controls whether	=item * <choicefunc>X<choicefunc>: Same as <filterfunc>, except that controls whether
the given resource can be chosen. (It is almost always a good idea to	the given resource can be chosen. (It is almost always a good idea to
show the user the folders, for instance, but you do not always want to	show the user the folders, for instance, but you do not always want to
let the user select them.)	let the user select them.)

=item * <nextstate>: Standard nextstate behavior.	=item * <nextstate>: Standard nextstate behavior.

=item * <valuefunc>: This function controls what is returned by the resource	=item * <valuefunc>X<valuefunc>: This function controls what is returned by the resource
when the user selects it. Like filterfunc and choicefunc, it should be	when the user selects it. Like filterfunc and choicefunc, it should be
a function fragment that when wrapped by "sub { my $res = shift; " and	a function fragment that when wrapped by "sub { my $res = shift; " and
"}" returns a string representing what you want to have as the value. By	"}" 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	=item * <mapurl>X<mapurl>: If the URL of a map is given here, only that map
will be displayed, instead of the whole course.	will be displayed, instead of the whole course. If the attribute
	"evaluate" is given and is true, the contents of the mapurl will be
	evaluated with "sub { my $helper = shift; my $state = shift;" and
	"}", with the return value used as the mapurl.

=back	=back

Line 1543 B<SUB-TAGS>	Line 1757 B<SUB-TAGS>
no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonnet;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::resource',	&Apache::lonhelper::register('Apache::lonhelper::resource',
('resource', 'filterfunc',	('resource', 'filterfunc',
'choicefunc', 'valuefunc',	'choicefunc', 'valuefunc',
'mapurl'));	'mapurl','option'));
}	}

sub new {	sub new {
Line 1569 sub start_resource {	Line 1784 sub start_resource {
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};	$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
$paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'};	$paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'};
$paramHash->{'toponly'} = $token->[2]{'toponly'};	$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'};
return '';	return '';
}	}

Line 1645 sub start_mapurl {	Line 1866 sub start_mapurl {

my $contents = Apache::lonxml::get_all_text('/mapurl',	my $contents = Apache::lonxml::get_all_text('/mapurl',
$parser);	$parser);
	$paramHash->{EVAL_MAP_URL} = $token->[2]{'evaluate'};
$paramHash->{MAP_URL} = $contents;	$paramHash->{MAP_URL} = $contents;
}	}

sub end_mapurl { return ''; }	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.	# 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 1683 sub render {	Line 1941 sub render {
}	}
</script>	</script>
SCRIPT	SCRIPT
	my %lt=&Apache::lonlocal::texthash(
	'sar' => "Select All Resources",
	'uar' => "Unselect All Resources");

$buttons = <<BUTTONS;	$buttons = <<BUTTONS;
<br />	<br />
<input type="button" onclick="checkall(true, '$var')" value="Select All Resources" />	<input type="button" onclick="checkall(true, '$var')" value="$lt{'sar'}" />
<input type="button" onclick="checkall(false, '$var')" value="Unselect All Resources" />	<input type="button" onclick="checkall(false, '$var')" value="$lt{'uar'}" />
<br />	<br />
BUTTONS	BUTTONS
}	}
Line 1697 BUTTONS	Line 1959 BUTTONS

$result .= $buttons;	$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'};
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->{EVAL_MAP_URL}) {
	my $mapUrlFunc = eval('sub { my $helper = shift; my $state = shift; ' .
	$self->{MAP_URL} . '}');
	$mapUrl = &$mapUrlFunc($helper, $self);
	} else {
	$mapUrl = $self->{MAP_URL};
	}


# Create the composite function that renders the column on the nav map	# 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 1709 BUTTONS	Line 1985 BUTTONS
my $checked = 0;	my $checked = 0;
my $renderColFunc = sub {	my $renderColFunc = sub {
my ($resource, $part, $params) = @_;	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;	my $inputType;
if ($multichoice) { $inputType = 'checkbox'; }	if ($multichoice) { $inputType = 'checkbox'; }
else {$inputType = 'radio'; }	else {$inputType = 'radio'; }

if (!&$choiceFunc($resource)) {	if (!&$choiceFunc($resource)) {
return '<td> </td>';	$result .= '<td> </td>';
	return $result;
} else {	} else {
my $col = "<td><input type='$inputType' name='${var}.forminput' ";	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";
	}
	$col .=
	"<td align='center'><input type='checkbox' name ='$option_var".
	".forminput' value='".
	$resource_name . "' $checked /> </td>";
	}
	}

	$col .= "<td align='center'><input type='$inputType' name='${var}.forminput' ";
if (!$checked && !$multichoice) {	if (!$checked && !$multichoice) {
$col .= "checked ";	$col .= "checked ";
$checked = 1;	$checked = 1;
Line 1726 BUTTONS	Line 2034 BUTTONS
$col .= "checked ";	$col .= "checked ";
$checked = 1;	$checked = 1;
}	}
$col .= "value='" .	$col .= "value='" . $resource_name . "' /></td>";
HTML::Entities::encode(&$valueFunc($resource))
. "' /></td>";	return $result.$col;
return $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'};	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());

	}
$result .=	$result .=
&Apache::lonnavmaps::render( { 'cols' => [$renderColFunc,	&Apache::lonnavmaps::render( { 'cols' => $cols,
Apache::lonnavmaps::resource()],
'showParts' => 0,	'showParts' => 0,
'filterFunc' => $filterFunc,	'filterFunc' => $filterFunc,
'resource_no_folder_link' => 1,	'resource_no_folder_link' => 1,
	'closeAllPages' => $self->{'closeallpages'},
'suppressEmptySequences' => $self->{'suppressEmptySequences'},	'suppressEmptySequences' => $self->{'suppressEmptySequences'},
'iterator_map' => $mapUrl }	'iterator_map' => $mapUrl }
);	);
Line 1770 package Apache::lonhelper::student;	Line 2120 package Apache::lonhelper::student;

=pod	=pod

=head2 Element: student	=head2 Element: studentX<student, helper element>

Student elements display a choice of students enrolled in the current	Student elements display a choice of students enrolled in the current
course. Currently it is primitive; this is expected to evolve later.	course. Currently it is primitive; this is expected to evolve later.

Student elements take two attributes: "variable", which means what	Student elements take the following attributes:
it usually does, and "multichoice", which if true allows the user
to select multiple students.	=over 4

	=item * B<variable>:

	Does what it usually does: declare which helper variable to put the
	result in.

	=item * B<multichoice>:

	If true allows the user to select multiple students. Defaults to false.

	=item * B<coursepersonnel>:

	If true adds the course personnel to the top of the student
	selection. Defaults to false.

	=item * B<activeonly>:

	If true, only active students and course personnel will be
	shown. Defaults to false.

	=back

=cut	=cut

no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal;
	use Apache::lonnet;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::student',	&Apache::lonhelper::register('Apache::lonhelper::student',
Line 1807 sub start_student {	Line 2178 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'};
	$paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
	$paramHash->{'activeonly'} = $token->[2]{'activeonly'};
if (defined($token->[2]{'nextstate'})) {	if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};	$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}	}
Line 1839 sub render {	Line 2212 sub render {
}	}
}	}
}	}
	function checksec(value) {
	for (i=0; i<document.forms.helpform.elements.length; i++) {
	comp = document.forms.helpform.elements.chksec.value;
	if (document.forms.helpform.elements[i].value.indexOf(':'+comp+':') != -1) {
	if (document.forms.helpform.elements[i].value.indexOf(':Active') != -1) {
	document.forms.helpform.elements[i].checked=value;
	}
	}
	}
	}
	function checkactive() {
	for (i=0; i<document.forms.helpform.elements.length; i++) {
	if (document.forms.helpform.elements[i].value.indexOf(':Active') != -1) {
	document.forms.helpform.elements[i].checked=true;
	}
	}
	}
	function uncheckexpired() {
	for (i=0; i<document.forms.helpform.elements.length; i++) {
	if (document.forms.helpform.elements[i].value.indexOf(':Expired') != -1) {
	document.forms.helpform.elements[i].checked=false;
	}
	}
	}
</script>	</script>
SCRIPT	SCRIPT

	my %lt=&Apache::lonlocal::texthash(
	'ocs' => "Select Only Current Students",
	'ues' => "Unselect Expired Students",
	'sas' => "Select All Students",
	'uas' => "Unselect All Students",
	'sfsg' => "Select Current Students for Section/Group",
	'ufsg' => "Unselect for Section/Group");

$buttons = <<BUTTONS;	$buttons = <<BUTTONS;
<br />	<br />
<input type="button" onclick="checkall(true, '$var')" value="Select All Students" />	<table>
<input type="button" onclick="checkall(false, '$var')" value="Unselect All Students" />	<tr>

	<td><input type="button" onclick="checkactive()" value="$lt{'ocs'}" /></td>
	<td><input type="button" onclick="uncheckexpired()" value="$lt{'ues'}" /><br /></td>
	</tr>
	<tr>
	<td><input type="button" onclick="checkall(true, '$var')" value="$lt{'sas'}" /></td>
	<td> <input type="button" onclick="checkall(false, '$var')" value="$lt{'uas'}" /><br /></td>
	</tr>
	<tr>
	<td><input type="button" onclick="checksec(true)" value="$lt{'sfsg'}"></td>
	<td><input type="text" size="5" name="chksec"> </td>
	</tr>
	<tr>
	<td><input type="button" onclick="checksec(false)" value="$lt{'ufsg'}"></td>
	<td></td>
	</tr>
	</table>
<br />	<br />
BUTTONS	BUTTONS
}	}
Line 1853 BUTTONS	Line 2276 BUTTONS
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';	$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
}	}

# Load up the students	my $choices = [];
my $choices = &Apache::loncoursedata::get_classlist();
my @keys = keys %{$choices};	# Load up the non-students, if necessary
	if ($self->{'coursepersonnel'}) {
	my %coursepersonnel = Apache::lonnet::get_course_adv_roles();
	for (sort keys %coursepersonnel) {
	for my $role (split /,/, $coursepersonnel{$_}) {
	# extract the names so we can sort them
	my @people;

	for (split /,/, $role) {
	push @people, [split /:/, $role];
	}

	@people = sort { $a->[0] cmp $b->[0] } @people;

	for my $person (@people) {
	push @$choices, [join(':', @$person), $person->[0], '', $_];
	}
	}
	}
	}

# Constants	# Constants
my $section = Apache::loncoursedata::CL_SECTION();	my $section = Apache::loncoursedata::CL_SECTION();
my $fullname = Apache::loncoursedata::CL_FULLNAME();	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	# Sort by: Section, name
@keys = sort {	@keys = sort {
if ($choices->{$a}->[$section] ne $choices->{$b}->[$section]) {	if ($classlist->{$a}->[$section] ne $classlist->{$b}->[$section]) {
return $choices->{$a}->[$section] cmp $choices->{$b}->[$section];	return $classlist->{$a}->[$section] cmp $classlist->{$b}->[$section];
}	}
return $choices->{$a}->[$fullname] cmp $choices->{$b}->[$fullname];	return $classlist->{$a}->[$fullname] cmp $classlist->{$b}->[$fullname];
} @keys;	} @keys;

	# username, fullname, section, type
	for (@keys) {
	# Filter out inactive students if we've set "activeonly"
	if (!$self->{'activeonly'} \|\| $classlist->{$_}->[$status] eq
	'Active') {
	push @$choices, [$_, $classlist->{$_}->[$fullname],
	$classlist->{$_}->[$section],
	$classlist->{$_}->[$status], 'Student'];
	}
	}

	my $name = $self->{'coursepersonnel'} ? &mt('Name') : &mt('Student Name');
my $type = 'radio';	my $type = 'radio';
if ($self->{'multichoice'}) { $type = 'checkbox'; }	if ($self->{'multichoice'}) { $type = 'checkbox'; }
$result .= "<table cellspacing='2' cellpadding='2' border='0'>\n";	$result .= "<table cellspacing='2' cellpadding='2' border='0'>\n";
$result .= "<tr><td></td><td align='center'><b>Student Name</b></td>".	$result .= "<tr><td></td><td align='center'><b>$name</b></td>".
"<td align='center'><b>Section</b></td></tr>";	"<td align='center'><b>" . &mt('Section') . "</b></td>" .
	"<td align='center'><b>".&mt('Status')."</b></td>" .
	"<td align='center'><b>" . &mt("Role") . "</b></td>" .
	"<td align='center'><b>".&mt('Username').":".&mt('Domain')."</b></td></tr>";

my $checked = 0;	my $checked = 0;
foreach (@keys) {	for my $choice (@$choices) {
$result .= "<tr><td><input type='$type' name='" .	$result .= "<tr><td><input type='$type' name='" .
$self->{'variable'} . '.forminput' . "'";	$self->{'variable'} . '.forminput' . "'";

Line 1885 BUTTONS	Line 2346 BUTTONS
$checked = 1;	$checked = 1;
}	}
$result .=	$result .=
" value='" . HTML::Entities::encode($_ . ':' . $choices->{$_}->[$section])	" value='" . HTML::Entities::encode($choice->[0] . ':'
	.$choice->[2] . ':'
	.$choice->[1] . ':'
	.$choice->[3], "<>&\"'")
. "' /></td><td>"	. "' /></td><td>"
. HTML::Entities::encode($choices->{$_}->[$fullname])	. HTML::Entities::encode($choice->[1],'<>&"')
. "</td><td align='center'>"	. "</td><td align='center'>"
. HTML::Entities::encode($choices->{$_}->[$section])	. HTML::Entities::encode($choice->[2],'<>&"')
. "</td></tr>\n";	. "</td>\n<td>"
	. HTML::Entities::encode($choice->[3],'<>&"')
	. "</td>\n<td>"
	. HTML::Entities::encode($choice->[4],'<>&"')
	. "</td>\n<td>"
	. HTML::Entities::encode($choice->[0],'<>&"')
	. "</td></tr>\n";
}	}

$result .= "</table>\n\n";	$result .= "</table>\n\n";
Line 1902 BUTTONS	Line 2372 BUTTONS
sub postprocess {	sub postprocess {
my $self = shift;	my $self = shift;

my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'};	my $result = $env{'form.' . $self->{'variable'} . '.forminput'};
if (!$result) {	if (!$result) {
$self->{ERROR_MSG} = 'You must choose at least one student '.	$self->{ERROR_MSG} =
'to continue.';	&mt('You must choose at least one student to continue.');
return 0;	return 0;
}	}

Line 1922 package Apache::lonhelper::files;	Line 2392 package Apache::lonhelper::files;

=pod	=pod

=head2 Element: files	=head2 Element: filesX<files, helper element>

files allows the users to choose files from a given directory on the	files allows the users to choose files from a given directory on the
server. It is always multichoice and stores the result as a triple-pipe	server. It is always multichoice and stores the result as a triple-pipe
Line 1938 are put. It accepts the attribute "multi	Line 2408 are put. It accepts the attribute "multi
defaulting to false, which if true will allow the user to select more	defaulting to false, which if true will allow the user to select more
then one choice.	then one choice.

<files> accepts three subtags. One is the "nextstate" sub-tag that works	<files> accepts three subtags:
as it does with the other tags. Another is a <filechoice> sub tag that
is Perl code that, when surrounded by "sub {" and "}" will return a	=over 4
string representing what directory on the server to allow the user to
choose files from. Finally, the <filefilter> subtag should contain Perl	=item * B<nextstate>: works as it does with the other tags.
code that when surrounded by "sub { my $filename = shift; " and "}",
returns a true value if the user can pick that file, or false otherwise.	=item * B<filechoice>: When the contents of this tag are surrounded by
The filename passed to the function will be just the name of the file,	"sub {" and "}", will return a string representing what directory
with no path info.	on the server to allow the user to choose files from.

	=item * B<filefilter>: Should contain Perl code that when surrounded
	by "sub { my $filename = shift; " and "}", returns a true value if
	the user can pick that file, or false otherwise. The filename
	passed to the function will be just the name of the file, with no
	path info. By default, a filter function will be used that will
	mask out old versions of files. This function is available as
	Apache::lonhelper::files::not_old_version if you want to use it to
	composite your own filters.

	=back

	B<General security note>: You should ensure the user can not somehow
	pass something into your code that would allow them to look places
	they should not be able to see, like the C</etc/> directory. However,
	the security impact would be minimal, since it would only expose
	the existence of files, there should be no way to parlay that into
	viewing the files.

=cut	=cut

no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal;
	use Apache::lonnet;
use Apache::lonpubdir; # for getTitleString	use Apache::lonpubdir; # for getTitleString

BEGIN {	BEGIN {
Line 1961 BEGIN {	Line 2450 BEGIN {
('files', 'filechoice', 'filefilter'));	('files', 'filechoice', 'filefilter'));
}	}

	sub not_old_version {
	my $file = shift;

	# Given a file name, return false if it is an "old version" of a
	# file, or true if it is not.

	if ($file =~ /^.*\.[0-9]+\.[A-Za-z]+(\.meta)?$/) {
	return 0;
	}
	return 1;
	}

sub new {	sub new {
my $ref = Apache::lonhelper::element->new();	my $ref = Apache::lonhelper::element->new();
bless($ref);	bless($ref);
Line 2016 sub start_filefilter {	Line 2517 sub start_filefilter {

sub end_filefilter { return ''; }	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 {	sub render {
my $self = shift;	my $self = shift;
my $result = '';	my $result = '';
Line 2028 sub render {	Line 2536 sub render {
my $subdir = &$subdirFunc();	my $subdir = &$subdirFunc();

my $filterFunc = $self->{FILTER_FUNC};	my $filterFunc = $self->{FILTER_FUNC};
	if (!defined($filterFunc)) {
	$filterFunc = &not_old_version;
	}
my $buttons = '';	my $buttons = '';
my $type = 'radio';	my $type = 'radio';
if ($self->{'multichoice'}) {	if ($self->{'multichoice'}) {
Line 2056 sub render {	Line 2567 sub render {
}	}
</script>	</script>
SCRIPT	SCRIPT
$buttons = <<BUTTONS;	my %lt=&Apache::lonlocal::texthash(
	'saf' => "Select All Files",
	'uaf' => "Unselect All Files");
	$buttons = <<BUTTONS;
<br />	<br />
<input type="button" onclick="checkall(true, '$var')" value="Select All Files" />	<input type="button" onclick="checkall(true, '$var')" value="$lt{'saf'}" />
<input type="button" onclick="checkall(false, '$var')" value="Unselect All Files" />	<input type="button" onclick="checkall(false, '$var')" value="$lt{'uaf'}" />
BUTTONS	BUTTONS

	%lt=&Apache::lonlocal::texthash(
	'sap' => "Select All Published",
	'uap' => "Unselect All Published");
if ($helper->{VARS}->{'construction'}) {	if ($helper->{VARS}->{'construction'}) {
$buttons .= <<BUTTONS;	$buttons .= <<BUTTONS;
<input type="button" onclick="checkallclass(true, 'Published')" value="Select All Published" />	<input type="button" onclick="checkallclass(true, 'Published')" value="$lt{'sap'}" />
<input type="button" onclick="checkallclass(false, 'Published')" value="Unselect All Published" />	<input type="button" onclick="checkallclass(false, 'Published')" value="$lt{'uap'}" />
<br />	<br />
BUTTONS	BUTTONS
}	}
Line 2075 BUTTONS	Line 2592 BUTTONS
my @fileList;	my @fileList;

# If the subdirectory is in local CSTR space	# If the subdirectory is in local CSTR space
if ($subdir =~ m\|/home/([^/]+)/public_html\|) {	my $metadir;
	if ($subdir =~ m\|/home/([^/]+)/public_html/(.*)\|) {
	my $user = $1;
	my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
	$metadir='/res/'.$domain.'/'.$user.'/'.$2;
	@fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
	} elsif ($subdir =~ m\|^~([^/]+)/(.*)$\|) {
	$subdir='/home/'.$1.'/public_html/'.$2;
my $user = $1;	my $user = $1;
my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};	my $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
	$metadir='/res/'.$domain.'/'.$user.'/'.$2;
@fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');	@fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
} else {	} else {
# local library server resource space	# 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'}, '');
}	}

	# Sort the fileList into order
	@fileList = sort {lc($a) cmp lc($b)} @fileList;

$result .= $buttons;	$result .= $buttons;

if (defined $self->{ERROR_MSG}) {	if (defined $self->{ERROR_MSG}) {
Line 2113 BUTTONS	Line 2641 BUTTONS
}	}

# Get the title	# Get the title
my $title = Apache::lonpubdir::getTitleString($fileName);	my $title = Apache::lonpubdir::getTitleString(($metadir?$metadir:$subdir) .'/'. $file);

# Netscape 4 is stupid and there's nowhere to put the	# Netscape 4 is stupid and there's nowhere to put the
# information on the input tag that the file is Published,	# information on the input tag that the file is Published,
Line 2134 BUTTONS	Line 2662 BUTTONS
if ($status eq 'Published' && $helper->{VARS}->{'construction'}) {	if ($status eq 'Published' && $helper->{VARS}->{'construction'}) {
$onclick = 'onclick="a=1" ';	$onclick = 'onclick="a=1" ';
}	}
	my $id = &new_id();
$result .= '<tr><td align="right"' . " bgcolor='$color'>" .	$result .= '<tr><td align="right"' . " bgcolor='$color'>" .
"<input $onclick type='$type' name='" . $var	"<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) {	if (!$self->{'multichoice'} && $choices == 0) {
$result .= ' checked';	$result .= ' 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'>$title</td>" .
"<td bgcolor='$color'>$status</td>" . "</tr>\n";	"<td bgcolor='$color'>$status</td>" . "</tr>\n";
$choices++;	$choices++;
Line 2151 BUTTONS	Line 2681 BUTTONS
$result .= "</table>\n";	$result .= "</table>\n";

if (!$choices) {	if (!$choices) {
$result .= '<font color="#FF0000">There are no files available to select in this directory. Please go back and select another option.</font><br /><br />';	$result .= '<font color="#FF0000">There are no files available to select in this directory ('.$subdir.'). Please go back and select another option.</font><br /><br />';
}	}

$result .= $buttons;	$result .= $buttons;
Line 2169 sub fileState {	Line 2699 sub fileState {
my $constructionSpaceDir = shift;	my $constructionSpaceDir = shift;
my $file = 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 $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
my $subdirpart = $constructionSpaceDir;	my $subdirpart = $constructionSpaceDir;
$subdirpart =~ s/^\/home\/$ENV{'user.name'}\/public_html//;	$subdirpart =~ s/^\/home\/$uname\/public_html//;
my $resdir = $docroot . '/res/' . $ENV{'user.domain'} . '/' . $ENV{'user.name'} .	my $resdir = $docroot . '/res/' . $udom . '/' . $uname .
$subdirpart;	$subdirpart;

my @constructionSpaceFileStat = stat($constructionSpaceDir . '/' . $file);	my @constructionSpaceFileStat = stat($constructionSpaceDir . '/' . $file);
Line 2192 sub fileState {	Line 2726 sub fileState {

sub postprocess {	sub postprocess {
my $self = shift;	my $self = shift;
my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'};	my $result = $env{'form.' . $self->{'variable'} . '.forminput'};
if (!$result) {	if (!$result) {
$self->{ERROR_MSG} = 'You must choose at least one file '.	$self->{ERROR_MSG} = 'You must choose at least one file '.
'to continue.';	'to continue.';
Line 2212 package Apache::lonhelper::section;	Line 2746 package Apache::lonhelper::section;

=pod	=pod

=head2 Element: section	=head2 Element: sectionX<section, helper element>

<section> allows the user to choose one or more sections from the current	<section> allows the user to choose one or more sections from the current
course.	course.
Line 2286 package Apache::lonhelper::string;	Line 2820 package Apache::lonhelper::string;

=pod	=pod

=head2 Element: string	=head2 Element: stringX<string, helper element>

string elements provide a string entry field for the user. string elements	string elements provide a string entry field for the user. string elements
take the usual 'variable' and 'nextstate' parameters. string elements	take the usual 'variable' and 'nextstate' parameters. string elements
Line 2301 string honors the validation function, i	Line 2835 string honors the validation function, i
no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::string',	&Apache::lonhelper::register('Apache::lonhelper::string',
Line 2344 sub render {	Line 2879 sub render {
my $result = '';	my $result = '';

if (defined $self->{ERROR_MSG}) {	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"';
Line 2395 package Apache::lonhelper::general;	Line 2930 package Apache::lonhelper::general;

=pod	=pod

=head2 General-purpose tag: <exec>	=head2 General-purpose tag: <exec>X<exec, helper tag>

The contents of the exec tag are executed as Perl code, not inside a	The contents of the exec tag are executed as Perl code, B<not> inside a
safe space, so the full range of $ENV and such is available. The code	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:	will be executed as a subroutine wrapped with the following code:

"sub { my $helper = shift; my $state = shift;" and	"sub { my $helper = shift; my $state = shift;" and
Line 2410 The return value is ignored.	Line 2945 The return value is ignored.
$helper is the helper object. Feel free to add methods to the helper	$helper is the helper object. Feel free to add methods to the helper
object to support whatever manipulation you may need to do (for instance,	object to support whatever manipulation you may need to do (for instance,
overriding the form location if the state is the final state; see	overriding the form location if the state is the final state; see
lonparm.helper for an example).	parameter.helper for an example).

$state is the $paramHash that has currently been generated and may	$state is the $paramHash that has currently been generated and may
be manipulated by the code in exec. Note that the $state is not yet	be manipulated by the code in exec. Note that the $state is not yet
Line 2419 be able to call methods on it.	Line 2954 be able to call methods on it.

=cut	=cut

	use Apache::lonlocal;
	use Apache::lonnet;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::general',	&Apache::lonhelper::register('Apache::lonhelper::general',
'exec', 'condition', 'clause',	'exec', 'condition', 'clause',
Line 2485 sub end_clause { return ''; }	Line 3023 sub end_clause { return ''; }

=pod	=pod

=head2 General-purpose tag: <eval>	=head2 General-purpose tag: <eval>X<eval, helper tag>

The <eval> tag will be evaluated as a subroutine call passed in the	The <eval> tag will be evaluated as a subroutine call passed in the
current helper object and state hash as described in <condition> above,	current helper object and state hash as described in <condition> above,
Line 2528 package Apache::lonhelper::final;	Line 3066 package Apache::lonhelper::final;

=pod	=pod

=head2 Element: final	=head2 Element: finalX<final, helper tag>

<final> is a special element that works with helpers that use the <finalcode>	<final> is a special element that works with helpers that use the <finalcode>
tag. It goes through all the states and elements, executing the <finalcode>	tagX<finalcode, helper tag>. It goes through all the states and elements, executing the <finalcode>
snippets and collecting the results. Finally, it takes the user out of the	snippets and collecting the results. Finally, it takes the user out of the
helper, going to a provided page.	helper, going to a provided page.

Line 2540 will make a "Finish Helper" button that	Line 3078 will make a "Finish Helper" button that
which is useful for the Course Initialization helper so the users never see	which is useful for the Course Initialization helper so the users never see
the old values taking effect.	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	=cut

no strict;	no strict;
@ISA = ("Apache::lonhelper::element");	@ISA = ("Apache::lonhelper::element");
use strict;	use strict;
	use Apache::lonlocal;
	use Apache::lonnet;
BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::final',	&Apache::lonhelper::register('Apache::lonhelper::final',
('final', 'exitpage'));	('final', 'exitpage'));
Line 2621 sub render {	Line 3163 sub render {
}	}
}	}

if (scalar(@results) == 0) {	my $result;
return '';
}

my $result = "<ul>\n";
for my $re (@results) {
$result .= ' <li>' . $re . "</li>\n";
}

if (!@results) {	if (scalar(@results) != 0) {
$result .= ' <li>No changes were made to current settings.</li>';	$result .= "<ul>\n";
	for my $re (@results) {
	$result .= ' <li>' . $re . "</li>\n";
	}

	if (!@results) {
	$result .= ' <li>' .
	&mt('No changes were made to current settings.') . '</li>';
	}

	$result .= '</ul>';
}	}

	my $actionURL = $self->{EXIT_PAGE};
	my $targetURL = '';
	my $finish=&mt('Finish');
if ($self->{'restartCourse'}) {	if ($self->{'restartCourse'}) {
$result .= "<center>\n" .	$actionURL = '/adm/roles';
"<form action='/adm/roles' method='post' target='loncapaclient'>\n" .	$targetURL = '/adm/menu';
"<input type='button' onclick='history.go(-1)' value='<- Previous' />" .	if ($env{'course.'.$env{'request.course.id'}.'.url'}=~/^uploaded/) {
"<input type='hidden' name='orgurl' value='/adm/menu' />" .	$targetURL = '/adm/coursedocs';
"<input type='hidden' name='selectrole' value='1' />\n" .	} else {
"<input type='hidden' name='" . $ENV{'request.role'} .	$targetURL = '/adm/navmaps';
"' value='1' />\n<input type='submit' value='Finish Course Initialization' />\n" .	}
"</form></center>";	if ($env{'course.'.$env{'request.course.id'}.'.clonedfrom'}) {
	$targetURL = '/adm/parmset?overview=1';
	}
	my $finish=&mt('Finish Course Initialization');
}	}
	my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
	my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
	$result .= "<center>\n" .
	"<form action='".$actionURL."' 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 . "' />\n" .
	"</form></center>";

return $result . '</ul>';	return $result;
}	}

sub overrideForm {	sub overrideForm {
my $self = shift;	return 1;
return $self->{'restartCourse'};
}	}

1;	1;
Line 2665 package Apache::lonhelper::parmwizfinal;	Line 3225 package Apache::lonhelper::parmwizfinal;
no strict;	no strict;
@ISA = ('Apache::lonhelper::element');	@ISA = ('Apache::lonhelper::element');
use strict;	use strict;
	use Apache::lonlocal;
	use Apache::lonnet;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::parmwizfinal',	&Apache::lonhelper::register('Apache::lonhelper::parmwizfinal',
Line 2695 sub render {	Line 3257 sub render {
my $vars = $helper->{VARS};	my $vars = $helper->{VARS};

# FIXME: Unify my designators with the standard ones	# FIXME: Unify my designators with the standard ones
my %dateTypeHash = ('open_date' => "Opening Date",	my %dateTypeHash = ('open_date' => "opening date",
'due_date' => "Due Date",	'due_date' => "due date",
'answer_date' => "Answer Date",	'answer_date' => "answer date",
'tries' => 'Number of Tries'	'tries' => 'number of tries',
	'weight' => 'problem weight'
);	);
my %parmTypeHash = ('open_date' => "0_opendate",	my %parmTypeHash = ('open_date' => "0_opendate",
'due_date' => "0_duedate",	'due_date' => "0_duedate",
'answer_date' => "0_answerdate",	'answer_date' => "0_answerdate",
'tries' => '0_maxtries' );	'tries' => '0_maxtries',
	'weight' => '0_weight' );

my $affectedResourceId = "";	my $affectedResourceId = "";
my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}};	my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}};
Line 2711 sub render {	Line 3275 sub render {
my $resourceString;	my $resourceString;
my $symb;	my $symb;
my $paramlevel;	my $paramlevel;

# Print the granularity, depending on the action	# Print the granularity, depending on the action
if ($vars->{GRANULARITY} eq 'whole_course') {	if ($vars->{GRANULARITY} eq 'whole_course') {
$resourceString .= '<li>for <b>all resources in the course</b></li>';	$resourceString .= '<li>'.&mt('for <b>all resources in the course</b>').'</li>';
$level = 9; # general course, see lonparmset.pm perldoc	if ($vars->{TARGETS} eq 'course') {
	$level = 11; # general course, see lonparmset.pm perldoc
	} elsif ($vars->{TARGETS} eq 'section') {
	$level = 6;
	} else {
	$level = 3;
	}
$affectedResourceId = "0.0";	$affectedResourceId = "0.0";
$symb = 'a';	$symb = 'a';
$paramlevel = 'general';	$paramlevel = 'general';
} elsif ($vars->{GRANULARITY} eq 'map') {	} elsif ($vars->{GRANULARITY} eq 'map') {
my $navmap = Apache::lonnavmaps::navmap->new(	my $navmap = Apache::lonnavmaps::navmap->new();
$ENV{"request.course.fn"}.".db",
$ENV{"request.course.fn"}."_parms.db", 0, 0);
my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});	my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
my $title = $res->compTitle();	my $title = $res->compTitle();
$symb = $res->symb();	$symb = $res->symb();
$navmap->untieHashes();	$resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
$resourceString .= "<li>for the map named <b>$title</b></li>";	if ($vars->{TARGETS} eq 'course') {
$level = 8;	$level = 10; # general course, see lonparmset.pm perldoc
	} elsif ($vars->{TARGETS} eq 'section') {
	$level = 5;
	} else {
	$level = 2;
	}
$affectedResourceId = $vars->{RESOURCE_ID};	$affectedResourceId = $vars->{RESOURCE_ID};
$paramlevel = 'map';	$paramlevel = 'map';
} else {	} else {
my $navmap = Apache::lonnavmaps::navmap->new(	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 $res = $navmap->getById($vars->{RESOURCE_ID});
	my $part = $vars->{RESOURCE_ID_part};
	if ($part ne 'All Parts' && $part) { $parm_name=~s/^0/$part/; } else { $part=&mt('All Parts'); }
$symb = $res->symb();	$symb = $res->symb();
my $title = $res->compTitle();	my $title = $res->compTitle();
$navmap->untieHashes();	$resourceString .= '<li>'.&mt('for the resource named [_1] part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
$resourceString .= "<li>for the resource named <b>$title</b></li>";	if ($vars->{TARGETS} eq 'course') {
$level = 7;	$level = 7; # general course, see lonparmset.pm perldoc
	} elsif ($vars->{TARGETS} eq 'section') {
	$level = 4;
	} else {
	$level = 1;
	}
$affectedResourceId = $vars->{RESOURCE_ID};	$affectedResourceId = $vars->{RESOURCE_ID};
$paramlevel = 'full';	$paramlevel = 'full';
}	}

my $result = "<form name='helpform' method='get' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";	my $result = "<form name='helpform' method='POST' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";
$result .= '<p>Confirm that this information is correct, then click "Finish Wizard" to complete setting the parameter.<ul>';	$result .= "<input type='hidden' name='action' value='settable' />\n";
	$result .= "<input type='hidden' name='dis' value='helper' />\n";
	if ($vars->{ACTION_TYPE} eq 'tries') {
	$result .= "<input type='hidden' name='pscat' value='maxtries' />\n";
	} else {
	$result .= "<input type='hidden' name='pscat' value='".
	HTML::Entities::encode($vars->{ACTION_TYPE},"'<>&\"") . "' />\n";
	}
	if ($vars->{GRANULARITY} eq 'resource') {
	$result .= "<input type='hidden' name='symb' value='".
	HTML::Entities::encode($symb,"'<>&\"") . "' />\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:	# Print the type of manipulation:
$result .= '<li>Setting the <b>' . $dateTypeHash{$vars->{ACTION_TYPE}} . '</b>';	my $extra;
if ($vars->{ACTION_TYPE} eq 'tries') {	if ($vars->{ACTION_TYPE} eq 'tries') {
$result .= ' to <b>' . $vars->{TRIES} . '</b>';	$extra = $vars->{TRIES};
	}
	if ($vars->{ACTION_TYPE} eq 'weight') {
	$extra = $vars->{WEIGHT};
	}
	$result .= "<li>";
	my $what = &mt($dateTypeHash{$vars->{ACTION_TYPE}});
	if ($extra) {
	$result .= &mt('Setting the [_1] to [_2]',"<b>$what</b>",$extra);
	} else {
	$result .= &mt('Setting the [_1]',"<b>$what</b>");
}	}
$result .= "</li>\n";	$result .= "</li>\n";
if ($vars->{ACTION_TYPE} eq 'due_date' \|\|	if ($vars->{ACTION_TYPE} eq 'due_date' \|\|
Line 2773 sub render {	Line 3378 sub render {
} elsif ($vars->{ACTION_TYPE} eq 'tries') {	} elsif ($vars->{ACTION_TYPE} eq 'tries') {
$result .= "<input type='hidden' name='pres_value' " .	$result .= "<input type='hidden' name='pres_value' " .
"value='" . $vars->{TRIES} . "' />\n";	"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";
}	}

$result .= $resourceString;	$result .= $resourceString;

# Print targets	# Print targets
if ($vars->{TARGETS} eq 'course') {	if ($vars->{TARGETS} eq 'course') {
$result .= '<li>for <b>all students in course</b></li>';	$result .= '<li>'.&mt('for <b>all students in course</b>').'</li>';
} elsif ($vars->{TARGETS} eq 'section') {	} elsif ($vars->{TARGETS} eq 'section') {
my $section = $vars->{SECTION_NAME};	my $section = $vars->{SECTION_NAME};
$result .= "<li>for section <b>$section</b></li>";	$result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';
$level -= 3;	$result .= "<input type='hidden' name='csec' value='" .
$result .= "<input type='hidden' name='csec' value='" .	HTML::Entities::encode($section,"'<>&\"") . "' />\n";
HTML::Entities::encode($section) . "' />\n";
} else {	} else {
# FIXME: This is probably wasteful! Store the name!	# FIXME: This is probably wasteful! Store the name!
my $classlist = Apache::loncoursedata::get_classlist();	my $classlist = Apache::loncoursedata::get_classlist();
Line 2793 sub render {	Line 3402 sub render {
# Chop off everything after the last colon (section)	# Chop off everything after the last colon (section)
$username = substr($username, 0, rindex($username, ':'));	$username = substr($username, 0, rindex($username, ':'));
my $name = $classlist->{$username}->[6];	my $name = $classlist->{$username}->[6];
$result .= "<li>for <b>$name</b></li>";	$result .= '<li>'.&mt('for [_1]',"<b>$name</b>").'</li>';
$level -= 6;	my ($uname, $udom) = split /:/, $vars->{USER_NAME};
my ($uname, $udom) = split /:/, $vars->{USER_NAME};
$result .= "<input type='hidden' name='uname' value='".	$result .= "<input type='hidden' name='uname' value='".
HTML::Entities::encode($uname) . "' />\n";	HTML::Entities::encode($uname,"'<>&\"") . "' />\n";
$result .= "<input type='hidden' name='udom' value='".	$result .= "<input type='hidden' name='udom' value='".
HTML::Entities::encode($udom) . "' />\n";	HTML::Entities::encode($udom,"'<>&\"") . "' />\n";
}	}

# Print value	# Print value
if ($vars->{ACTION_TYPE} ne 'tries') {	if ($vars->{ACTION_TYPE} ne 'tries' && $vars->{ACTION_TYPE} ne 'weight') {
$result .= "<li>to <b>" . ctime($vars->{PARM_DATE}) . "</b> (" .	$result .= '<li>'.&mt('to [_1] ([_2])',"<b>".ctime($vars->{PARM_DATE})."</b>",Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}))."</li>\n";
Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE})
. ")</li>\n";
}	}

# print pres_marker	# print pres_marker
Line 2819 sub render {	Line 3425 sub render {
$result .= "\n<input type='hidden' value='$symb' name='pssymb' />";	$result .= "\n<input type='hidden' value='$symb' name='pssymb' />";
$result .= "\n<input type='hidden' value='$paramlevel' name='parmlev' />";	$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;	return $result;
}	}

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.38
changed lines
	Added in v.1.105