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.128 and 1.197.2.2.2.2

version 1.128, 2005/11/22 12:49:50	version 1.197.2.2.2.2, 2023/02/03 14:15:09
Line 64 messages, resource selections, or date q	Line 64 messages, resource selections, or date q

The helper tag is required to have one attribute, "title", which is the name	The helper tag is required to have one attribute, "title", which is the name
of the helper itself, such as "Parameter helper". The helper tag may optionally	of the helper itself, such as "Parameter helper". The helper tag may optionally
have a "requiredpriv" attribute, specifying the priviledge a user must have	have a "requiredpriv" attribute, specifying the privilege a user must have
to use the helper, or get denied access. See loncom/auth/rolesplain.tab for	to use the helper, or get denied access. See loncom/auth/rolesplain.tab for
useful privs. Default is full access, which is often wrong!	useful privs. You may add the modifier &S at the end of the three letter priv
	if you want to grant access to users for whom the corresponding privilege is
	section-specific. The default is full access, which is often wrong!

=head2 State tags	=head2 State tags

Line 81 State tags are also required to have an	Line 83 State tags are also required to have an
human name of the state, and will be displayed as the header on top of	human name of the state, and will be displayed as the header on top of
the screen for the user.	the screen for the user.

	State tags may also optionally have an attribute "help" which should be
	the filename of a help file, this will add a blue ? to the title.

=head2 Example Helper Skeleton	=head2 Example Helper Skeleton

An example of the tags so far:	An example of the tags so far:

<helper title="Example Helper">	<helper title="Example Helper">
<state name="START" title="Demonstrating the Example Helper">	<state name="START" title="Demonstrating the Example Helper">
<!-- notice this is the START state the wizard requires -->	<!-- notice this is the START state the helper requires -->
</state>	</state>
<state name="GET_NAME" title="Enter Student Name">	<state name="GET_NAME" title="Enter Student Name">
</state>	</state>
</helper>	</helper>

Of course this does nothing. In order for the wizard to do something, it is	Of course this does nothing. In order for the helper to do something, it is
necessary to put actual elements into the wizard. Documentation for each	necessary to put actual elements into the helper. Documentation for each
of these elements follows.	of these elements follows.

=head1 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 helper (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
issues or the fact that the code actually outweighs the XML. It is	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.	possible to create a helper via code, though it is a little odd.
Line 183 use Apache::File;	Line 188 use Apache::File;
use Apache::lonxml;	use Apache::lonxml;
use Apache::lonlocal;	use Apache::lonlocal;
use Apache::lonnet;	use Apache::lonnet;
	use Apache::longroup;
	use Apache::lonselstudent;


	use LONCAPA;

# 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 253 sub real_handler {	Line 263 sub real_handler {
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 = $r->dir_config('lonDocRoot').$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;
Line 275 sub real_handler {	Line 285 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}.	my ($priv,$modifier) = split(/\&/,$helper->{REQUIRED_PRIV});
	$env{'user.error.msg'} = $env{'request.uri'}.':'.$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 331 sub start_state {	Line 342 sub start_state {
}	}

Apache::lonhelper::state->new($token->[2]{'name'},	Apache::lonhelper::state->new($token->[2]{'name'},
$token->[2]{'title'});	$token->[2]{'title'},
	$token->[2]{'help'});
return '';	return '';
}	}

Line 361 use Apache::loncommon;	Line 373 use Apache::loncommon;
use Apache::File;	use Apache::File;
use Apache::lonlocal;	use Apache::lonlocal;
use Apache::lonnet;	use Apache::lonnet;
	use LONCAPA;

sub new {	sub new {
my $proto = shift;	my $proto = shift;
Line 466 sub _saveVars {	Line 479 sub _saveVars {
sub _varsInFile {	sub _varsInFile {
my $self = shift;	my $self = shift;
my @vars = ();	my @vars = ();
for my $key (keys %{$self->{VARS}}) {	for my $key (keys(%{$self->{VARS}})) {
push @vars, &Apache::lonnet::escape($key) . '=' .	push(@vars, &escape($key) . '=' . &escape($self->{VARS}->{$key}));
&Apache::lonnet::escape($self->{VARS}->{$key});
}	}
return join ('&', @vars);	return join ('&', @vars);
}	}
Line 483 sub declareVar {	Line 495 sub declareVar {
$self->{VARS}->{$var} = '';	$self->{VARS}->{$var} = '';
}	}

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}});
Line 499 sub allowedCheck {	Line 511 sub allowedCheck {
if (!defined($self->{REQUIRED_PRIV})) {	if (!defined($self->{REQUIRED_PRIV})) {
return 1;	return 1;
}	}
	my ($priv,$modifier) = split(/\&/,$self->{REQUIRED_PRIV});
return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $env{'request.course.id'});	my $allowed = &Apache::lonnet::allowed($priv,$env{'request.course.id'});
	if ((!$allowed) && ($modifier eq 'S') && ($env{'request.course.sec'} ne '')) {
	$allowed = &Apache::lonnet::allowed($priv,$env{'request.course.id'}.'/'.
	$env{'request.course.sec'});
	}
	return $allowed;
}	}

sub changeState {	sub changeState {
Line 522 sub process {	Line 539 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 &mt("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 562 sub process {	Line 579 sub process {
# 4: Render the current state to the screen as an HTML page.	# 4: Render the current state to the screen as an HTML page.
sub display {	sub display {
my $self = shift;	my $self = shift;
	my $footer = shift;
my $state = $self->{STATES}{$self->{STATE}};	my $state = $self->{STATES}{$self->{STATE}};

my $result = "";	my $result = "";
Line 573 sub display {	Line 590 sub display {
}	}

# Phase 4: Display.	# Phase 4: Display.
my $html=&Apache::lonxml::xmlbegin();
my $stateTitle=&mt($state->title());	my $stateTitle=&mt($state->title());
my $helperTitle = &mt($self->{TITLE});	my $stateHelp= $state->help();
my $bodytag = &Apache::loncommon::bodytag($helperTitle,'','');	my $browser_searcher_js =
my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');	'<script type="text/javascript">'."\n".
my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');	&Apache::loncommon::browser_and_searcher_javascript().
# FIXME: This should be parameterized, not concatenated - Jeremy	"\n".'</script>';
my $loncapaHelper = &mt("LON-CAPA Helper:");
	# Breadcrumbs
	my $brcrum = [{'href' => '',
	'text' => 'Helper'}];
	# FIXME: Dynamically add context sensitive breadcrumbs
	# depending on the caller,
	# e.g. printing, parametrization, etc.
	# FIXME: Add breadcrumbs to reflect current helper state

	$result .= &Apache::loncommon::start_page($self->{TITLE},
	$browser_searcher_js,
	{'bread_crumbs' => $brcrum,});

$result .= <<HEADER;	my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
$html	my $next = HTML::Entities::encode(&mt("Next"), '<>&"');
<head>	# FIXME: This should be parameterized, not concatenated - Jeremy
<title>$loncapaHelper: $helperTitle</title>
</head>
$bodytag
HEADER
if (!$state->overrideForm()) { $result.="<form name='helpform' method='POST'>"; }
$result .= <<HEADER;
<table border="0" width='100%'><tr><td>
<h2><i>$stateTitle</i></h2>
HEADER

$result .= "<table cellpadding='10' width='100%'><tr><td rowspan='2' valign='top'>";

if (!$state->overrideForm()) {	if (!$state->overrideForm()) { $result.='<form name="helpform" method="post" action="">'; }
$result .= $self->_saveVars();	if ($stateHelp) {
	$stateHelp = &Apache::loncommon::help_open_topic($stateHelp);
}	}
$result .= $state->render();

$result .= "</td><td valign='top' align='right'>";	# Prepare buttons
	my $buttons;
# Warning: Copy and pasted from below, because it's too much trouble to
# turn this into a subroutine
if (!$state->overrideForm()) {	if (!$state->overrideForm()) {
if ($self->{STATE} ne $self->{START_STATE}) {	if ($self->{STATE} ne $self->{START_STATE}) {
#$result .= '<input name="SUBMIT" type="submit" value="<- Previous" />  ';	#$result .= '<input name="SUBMIT" type="submit" value="<- Previous" />  ';
}	}
	$buttons = '<p>'; # '<fieldset>';
if ($self->{DONE}) {	if ($self->{DONE}) {
my $returnPage = $self->{RETURN_PAGE};	my $returnPage = $self->{RETURN_PAGE};
$result .= "<a href=\"$returnPage\">" . &mt("End Helper") . "</a>";	$buttons .= '<a href="'.$returnPage.'">'.&mt('End Helper').'</a>';
}	}
else {	else {
$result .= '<nobr><input name="back" type="button" ';	$buttons .= '<span class="LC_nobreak">'
$result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';	.'<input name="back" type="button" '
$result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';	.'value="'.$previous.'" onclick="history.go(-1)" /> '
	.'<input name="SUBMIT" type="submit" value="'.$next.'" />'
	.'</span>';
}	}
	$buttons .= '</p>'; # '</fieldset>';
}	}

$result .= "</td></tr><tr><td valign='bottom' align='right'>";

# Warning: Copy and pasted from above, because it's too much trouble to
# turn this into a subroutine	$result .= '<h2>'.$stateTitle.$stateHelp.'</h2>';

	# $result .= '<div>';

	# Top buttons
	$result .= $buttons;

	# Main content of current helper screen
if (!$state->overrideForm()) {	if (!$state->overrideForm()) {
if ($self->{STATE} ne $self->{START_STATE}) {	$result .= $self->_saveVars();
#$result .= '<input name="SUBMIT" type="submit" value="<- Previous" />  ';
}
if ($self->{DONE}) {
my $returnPage = $self->{RETURN_PAGE};
$result .= "<a href=\"$returnPage\">" . &mt('End Helper') . "</a>";
}
else {
$result .= '<nobr><input name="back" type="button" ';
$result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
$result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
}
}	}
	$result .= $state->render();

#foreach my $key (keys %{$self->{VARS}}) {	# Bottom buttons
	$result .= $buttons;


	#foreach my $key (keys(%{$self->{VARS}})) {
# $result .= "\|$key\| -> " . $self->{VARS}->{$key} . "<br />";	# $result .= "\|$key\| -> " . $self->{VARS}->{$key} . "<br />";
#}	#}

$result .= "</td></tr></table>";	# $result .= '</div>';

$result .= <<FOOTER;	$result .= <<FOOTER;
</td>
</tr>
</table>
</form>	</form>
</body>
</html>
FOOTER	FOOTER

	$result .= $footer.&Apache::loncommon::end_page();
# Handle writing out the vars to the file	# Handle writing out the vars to the file
my $file = Apache::File->new('>'.$self->{FILENAME});	my $file = Apache::File->new('>'.$self->{FILENAME});
print $file $self->_varsInFile();	print $file $self->_varsInFile();
Line 680 sub new {	Line 695 sub new {

$self->{NAME} = shift;	$self->{NAME} = shift;
$self->{TITLE} = shift;	$self->{TITLE} = shift;
	$self->{HELP} = shift;
$self->{ELEMENTS} = [];	$self->{ELEMENTS} = [];

bless($self, $class);	bless($self, $class);
Line 701 sub title {	Line 717 sub title {
return $self->{TITLE};	return $self->{TITLE};
}	}

	sub help {
	my $self = shift;
	return $self->{HELP};
	}

sub preprocess {	sub preprocess {
my $self = shift;	my $self = shift;
for my $element (@{$self->{ELEMENTS}}) {	for my $element (@{$self->{ELEMENTS}}) {
Line 792 the element. How this value is interpret	Line 813 the element. How this value is interpret
the element itself, and possibly the settings the element has (such as	the element itself, and possibly the settings the element has (such as
multichoice vs. single choice for <choices> tags).	multichoice vs. single choice for <choices> tags).

This is also intended for things like the course initialization wizard, where the	This is also intended for things like the course initialization helper, where the
user is setting various parameters. By correctly grabbing current settings	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	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	helper later and re-execute it, without needing to worry about overwriting
Line 994 sub start_message {	Line 1015 sub start_message {
if (defined($token->[2]{'nextstate'})) {	if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};	$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}	}
	if (defined($token->[2]{'type'})) {
	$paramHash->{TYPE} = $token->[2]{'type'};
	}
return '';	return '';
}	}

Line 1009 sub end_message {	Line 1033 sub end_message {

sub render {	sub render {
my $self = shift;	my $self = shift;

return &mtn($self->{MESSAGE_TEXT});	if ($self->{TYPE} =~ /^\swarning\s$/i) {
	$self->{MESSAGE_TEXT} =
	'<span class="LC_warning">'. $self->{MESSAGE_TEXT}.'</span>';
	}
	if ($self->{TYPE} =~ /^\serror\s$/i) {
	$self->{MESSAGE_TEXT} =
	'<span class="LC_error">'. $self->{MESSAGE_TEXT}.'</span>';
	}
	return $self->{MESSAGE_TEXT};
}	}
# If a NEXTSTATE was given, switch to it	# If a NEXTSTATE was given, switch to it
sub postprocess {	sub postprocess {
Line 1023 sub postprocess {	Line 1055 sub postprocess {
}	}
1;	1;

	package Apache::lonhelper::helpicon;

	=pod

	=head1 Elements

	=head2 Element: helpiconX<helpicon, helper element>

	Helpicon elements add a help icon at the current location.
	Example:

	<helpicon file="Help">
	General Help
	</helpicon>

	In this example will generate a help icon to the Help.hlp url with a
	description of 'General Help'. The description is not required and if
	left out (Example: <helpicon file="Help" /> only the icon will be
	added.)

	=head3 Localization

	The description text will be run through the normalize_string function
	and that will be used as a call to &mt.

	=cut

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

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

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

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

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

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

	$paramHash->{HELP_TEXT} =~s/^\s+//;
	$paramHash->{HELP_TEXT} =~s/\s+$//;

	if (defined($token->[2]{'file'})) {
	$paramHash->{HELP_FILE} = $token->[2]{'file'};
	}
	return '';
	}

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

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

	sub render {
	my $self = shift;

	my $text;
	if ( $self->{HELP_TEXT} ne '') {
	$text=&mtn($self->{HELP_TEXT});
	}

	return &Apache::loncommon::help_open_topic($self->{HELP_FILE},
	$text);
	}
	sub postprocess {
	my $self = shift;
	if (defined($self->{NEXTSTATE})) {
	$helper->changeState($self->{NEXTSTATE});
	}

	return 1;
	}

	1;

	package Apache::lonhelper::skip;

	=pod

	=head1 Elements

	=head2 Element: skipX<skip>

	The <skip> tag allows you define conditions under which the current state
	should be skipped over and define what state to skip to.

	<state name="SKIP">
	<skip>
	<clause>
	#some code that decides whether to skip the state or not
	</clause>
	<nextstate>FINISH</nextstate>
	</skip>
	<message nextstate="FINISH">A possibly skipped state</message>
	</state>

	=cut

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

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

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

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

	if ($target ne 'helper') {
	return '';
	}
	# let <cluase> know what text to skip to
	$paramHash->{SKIPTAG}='/skip';
	return '';
	}

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

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

	sub render {
	my $self = shift;
	return '';
	}
	# If a NEXTSTATE is set, switch to it
	sub preprocess {
	my ($self) = @_;

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

	return 1;
	}

	1;

package Apache::lonhelper::choices;	package Apache::lonhelper::choices;

=pod	=pod
Line 1072 will be the state transistioned to if th	Line 1273 will be the state transistioned to if th
the choice is not multichoice. This will override the nextstate	the choice is not multichoice. This will override the nextstate
passed to the parent C<choices> tag.	passed to the parent C<choices> tag.

	<choice> may optionally contain a 'relatedvalue' attribute, which
	if present will cause a text entry to appear to the right of the
	selection. The value of the relatedvalue attribute is a variable
	into which the text entry will be stored e.g.:
	<choice computer='numberprovided" relatedvalue="num">Type the number in:</choice>

	<choice> may contain a relatededefault atribute which, if the
	relatedvalue attribute is present will be the initial value of the input
	box.

=back	=back

To create the choices programmatically, either wrap the choices in	To create the choices programmatically, either wrap the choices in
Line 1162 sub start_choice {	Line 1373 sub start_choice {
my $computer = $token->[2]{'computer'};	my $computer = $token->[2]{'computer'};
my $human = &mt(&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'};
	my $relatedVar = $token->[2]{'relatedvalue'};
	my $relatedDefault = $token->[2]{'relateddefault'};
push @{$paramHash->{CHOICES}}, [&mtn($human), $computer, $nextstate,	push @{$paramHash->{CHOICES}}, [&mtn($human), $computer, $nextstate,
$evalFlag];	$evalFlag, $relatedVar, $relatedDefault];
return '';	return '';
}	}

Line 1193 sub render {	Line 1406 sub render {
function checkall(value, checkName) {	function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {	for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];	ele = document.forms.helpform.elements[i];
if (ele.name == checkName + '.forminput') {	if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;	document.forms.helpform.elements[i].checked=value;
}	}
}	}
Line 1266 BUTTONS	Line 1479 BUTTONS
foreach my $choice (@{$self->{CHOICES}}) {	foreach my $choice (@{$self->{CHOICES}}) {
my $id = &new_id();	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='checked' ";	$result .= " checked='checked'";
}	}
$result .= qq{id="id$id"};	$result .= qq{ id="id$id"};
my $choiceLabel = $choice->[0];	my $choiceLabel = $choice->[0];
if ($choice->[4]) { # if we need to evaluate this choice	if ($choice->[3]) { # if we need to evaluate this choice
$choiceLabel = "sub { my $helper = shift; my $state = shift;" .	$choiceLabel = "sub { my $helper = shift; my $state = shift;" .
$choiceLabel . "}";	$choiceLabel . "}";
$choiceLabel = eval($choiceLabel);	$choiceLabel = eval($choiceLabel);
$choiceLabel = &$choiceLabel($helper, $self);	$choiceLabel = &$choiceLabel($helper, $self);
}	}
$result .= "/></td><td> ".qq{<label for="id$id">}.	$result .= " /></td><td> ".qq{<label for="id$id">}.
$choiceLabel. "</label></td></tr>\n";	$choiceLabel. "</label></td>";
	if ($choice->[4]) {
	$result .='<td><input type="text" size="5" name="'
	.$choice->[4].'_forminput" value="'
	.$choice->[5].'" /></td>';
	}
	$result .= "</tr>\n";
}	}
$result .= "</table>\n\n\n";	$result .= "</table>\n\n\n";
$result .= $buttons;	$result .= $buttons;
Line 1294 BUTTONS	Line 1513 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} =	$self->{ERROR_MSG} =
Line 1302 sub postprocess {	Line 1522 sub postprocess {
return 0;	return 0;
}	}



if (ref($chosenValue)) {	if (ref($chosenValue)) {
$helper->{VARS}->{$self->{'variable'}} = join('\|\|\|', @$chosenValue);	$helper->{VARS}->{$self->{'variable'}} = join('\|\|\|', @$chosenValue);
}	}
Line 1316 sub postprocess {	Line 1538 sub postprocess {
$helper->changeState($choice->[2]);	$helper->changeState($choice->[2]);
}	}
}	}
	if ($choice->[4]) {
	my $varname = $choice->[4];
	$helper->{'VARS'}->{$varname} = $env{'form.'."${varname}_forminput"};
	}
}	}
return 1;	return 1;
}	}
Line 1423 sub render {	Line 1649 sub render {
$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;	$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
}	}

$result .= "<select name='${var}.forminput'>\n";	$result .= "<select name='${var}_forminput'>\n";
foreach my $choice (@{$self->{CHOICES}}) {	foreach my $choice (@{$self->{CHOICES}}) {
$result .= "<option value='" .	$result .= "<option value='" .
HTML::Entities::encode($choice->[1],"<>&\"'")	HTML::Entities::encode($choice->[1],"<>&\"'")
Line 1449 sub render {	Line 1675 sub render {
# 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} = "You must choose one or more choices to" .
Line 1509 no strict;	Line 1735 no strict;
use strict;	use strict;
use Apache::lonlocal; # A localization nightmare	use Apache::lonlocal; # A localization nightmare
use Apache::lonnet;	use Apache::lonnet;
use Time::localtime;	use DateTime;

BEGIN {	BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::date',	&Apache::lonhelper::register('Apache::lonhelper::date',
Line 1559 sub render {	Line 1785 sub render {
my $time=time;	my $time=time;
my ($anytime,$onclick);	my ($anytime,$onclick);

if (defined($self->{DEFAULT_VALUE})) {	# first check VARS for a valid new value from the user
	# then check DEFAULT_VALUE for a valid default time value
	# otherwise pick now as reasonably good time

	if (defined($helper->{VARS}{$var})
	&& $helper->{VARS}{$var} > 0) {
	$date = &get_date_object($helper->{VARS}{$var});
	} elsif (defined($self->{DEFAULT_VALUE})) {
my $valueFunc = eval($self->{DEFAULT_VALUE});	my $valueFunc = eval($self->{DEFAULT_VALUE});
die('Error in default value code for variable ' .	die('Error in default value code for variable ' .
$self->{'variable'} . ', Perl said: ' . $@) if $@;	$self->{'variable'} . ', Perl said: ' . $@) if $@;
$time = &$valueFunc($helper, $self);	$time = &$valueFunc($helper, $self);
if (lc($time) eq 'anytime') { $time=time; $anytime=1; }	if (lc($time) eq 'anytime') {
	$anytime=1;
	$date = &get_date_object(time);
	$date->set_minute(0);
	} elsif (defined($time) && $time ne 0) {
	$date = &get_date_object($time);
	} else {
	# leave date undefined so it'll default to now
	}
	}

	if (!defined($date)) {
	$date = &get_date_object(time);
	$date->set_minute(0);
}	}

if ($anytime) {	if ($anytime) {
$onclick = "onclick=\"javascript:updateCheck(this.form,'${var}anytime',false)\"";	$onclick = "onclick=\"javascript:updateCheck(this.form,'${var}anytime',false)\"";
}	}
# Default date: The current hour.	# Default date: The current hour.
$date = localtime($time);
$date->min(0);

if (defined $self->{ERROR_MSG}) {	if (defined $self->{ERROR_MSG}) {
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';	$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
Line 1581 sub render {	Line 1826 sub render {
my $i;	my $i;
$result .= "<select $onclick name='${var}month'>\n";	$result .= "<select $onclick name='${var}month'>\n";
for ($i = 0; $i < 12; $i++) {	for ($i = 0; $i < 12; $i++) {
if ($i == $date->mon) {	if (($i + 1) == $date->mon) {
$result .= "<option value='$i' selected='selected'>";	$result .= "<option value='$i' selected='selected'>";
} else {	} else {
$result .= "<option value='$i'>";	$result .= "<option value='$i'>";
}	}
$result .= &mt($months[$i]) . "</option>\n";	$result .= &mt($months[$i])."</option>\n";
}	}
$result .= "</select>\n";	$result .= "</select>\n";

Line 1605 sub render {	Line 1850 sub render {
# Year	# Year
$result .= "<select $onclick name='${var}year'>\n";	$result .= "<select $onclick name='${var}year'>\n";
for ($i = 2000; $i < 2030; $i++) { # update this after 64-bit dates	for ($i = 2000; $i < 2030; $i++) { # update this after 64-bit dates
if ($date->year + 1900 == $i) {	if ($date->year == $i) {
$result .= "<option selected='selected'>";	$result .= "<option selected='selected'>";
} else {	} else {
$result .= "<option>";	$result .= "<option>";
Line 1660 sub render {	Line 1905 sub render {
}	}
$result .= "</select>\n";	$result .= "</select>\n";
}	}
	$result .= ' '.$date->time_zone_short_name().' ';
if ($self->{'anytime'}) {	if ($self->{'anytime'}) {
$result.=(<<CHECK);	$result.=(<<CHECK);
<script type="text/javascript">	<script type="text/javascript">
Line 1675 CHECK	Line 1921 CHECK
if ($anytime) {	if ($anytime) {
$result.=' checked="checked" '	$result.=' checked="checked" '
}	}
$result.="name='${var}anytime'/>".&mt('Anytime').'</label>'	my $anytimetext = &mt('Any time');
	if (($var eq 'startreserve') \|\| ($var eq 'endreserve')) {
	$anytimetext = &mt('Any time before slot starts');
	} elsif (($var eq 'startunique') \|\| ($var eq 'endunique')) {
	$anytimetext = &mt('No restriction on uniqueness');
	}
	$result.="name='${var}anytime'/>".$anytimetext.'</label>'
}	}
return $result;	return $result;

Line 1687 sub postprocess {	Line 1939 sub postprocess {
if ($env{'form.' . $var . 'anytime'}) {	if ($env{'form.' . $var . 'anytime'}) {
$helper->{VARS}->{$var} = undef;	$helper->{VARS}->{$var} = undef;
} else {	} else {
my $month = $env{'form.' . $var . 'month'};	my $month = $env{'form.' . $var . 'month'};
	$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;
Line 1697 sub postprocess {	Line 1950 sub postprocess {
$hour = $env{'form.' . $var . 'hour'};	$hour = $env{'form.' . $var . 'hour'};
}	}

my $chosenDate;	my ($chosenDate,$checkDate);
eval {$chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);};	my $timezone = &Apache::lonlocal::gettimezone();
	my $dt;
	eval {
	$dt = DateTime->new( year => $year,
	month => $month,
	day => $day,
	hour => $hour,
	minute => $min,
	second => 0,
	time_zone => $timezone,
	);
	};

my $error = $@;	my $error = $@;
	if (!$error) {
	$chosenDate = $dt->epoch;
	$checkDate = &get_date_object($chosenDate);
	}

# Check to make sure that the date was not automatically co-erced into a	# 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 leap year	# 3, depending on if it's a leap year
my $checkDate = localtime($chosenDate);

if ($error \|\| $checkDate->mon != $month \|\| $checkDate->mday != $day \|\|	if ($error \|\| $checkDate->mon != $month \|\| $checkDate->mday != $day \|\|
$checkDate->year + 1900 != $year) {	$checkDate->year != $year) {
unless (Apache::lonlocal::current_language()== ~/^en/) {	unless (Apache::lonlocal::current_language()== ~/^en/) {
$self->{ERROR_MSG} = &mt("Invalid date entry");	$self->{ERROR_MSG} = &mt("Invalid date entry");
return 0;	return 0;
}	}
# LOCALIZATION FIXME: Needs to be parameterized	# 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[$env{'form.'.$var.'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;
}	}
$helper->{VARS}->{$var} = $chosenDate;	$helper->{VARS}->{$var} = $chosenDate;
}	}

	if (defined($self->{VALIDATOR})) {
	my $validator = eval($self->{VALIDATOR});
	die 'Died during evaluation of validator code; Perl said: ' . $@ if $@;
	my $invalid = &$validator($helper, $state, $self, $self->getValue());
	if ($invalid) {
	$self->{ERROR_MSG} = $invalid;
	return 0;
	}
	}

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

return 1;	return 1;
}	}

	sub get_date_object {
	my ($epoch) = @_;
	my $dt = DateTime->from_epoch(epoch => $epoch)
	->set_time_zone(&Apache::lonlocal::gettimezone());
	my $lang = Apache::lonlocal::current_language();
	if ($lang ne '') {
	eval {
	$dt->set_locale($lang);
	};
	}
	return $dt;
	}

1;	1;

package Apache::lonhelper::resource;	package Apache::lonhelper::resource;
Line 1754 folders that have all of their contained	Line 2046 folders that have all of their contained
be filtered out. The 'addstatus' attribute, if true, will add the icon	be filtered out. The 'addstatus' attribute, if true, will add the icon
and long status display columns to the display. The 'addparts'	and long status display columns to the display. The 'addparts'
attribute will add in a part selector beside problems that have more	attribute will add in a part selector beside problems that have more
than 1 part.	than 1 part. The 'includecourse' attribute if true, will include
	the toplevel default.sequence in the results. The 'modalLink' attribute,
	if true, will cause links to be launched as modal pop-ups, instead of
	replacing the resource selection listing, currently being displayed.

=head3 SUB-TAGS	=head3 SUB-TAGS

Line 1787 than 1 part.	Line 2082 than 1 part.
evaluated with "sub { my $helper = shift; my $state = shift;" and	evaluated with "sub { my $helper = shift; my $state = shift;" and
"}", with the return value used as the mapurl.	"}", with the return value used as the mapurl.

	=item * <option />: Allows you to add optional elements to the
	resource chooser currently these can be a checkbox, or a text entry
	or hidden (see the 'type' attribute below).
	the following attributes are supported by this tag:

	=over 4

	=item * type=control-type : determines the type of control displayed.
	This can be one of the following types: 'checkbox' provides a true/false
	checkbox. 'text' provides a text entry control. 'hidden' provides a
	hidden form element that returns the name of the resource for each
	element of the text box.

	=item * text=header-text : provides column header text for the option.

	=item * variable=helpervar : provides a helper variable to contain the
	value of the input control for each resource. In general, the result
	will be a set of values separated by \|\|\| for the checkbox the value between
	the \|\|\|'s will either be empty, if the box is not checked, or the resource
	name if checked. For the text entry, the values will be the text in the
	text box. This could be empty. Hidden elements unconditionally provide
	the resource name for each row of the chooser and allow you to therefore
	correlate text entries to their resources.
	The helper variable can be initialized by the user code to pre-load values
	into the controls:

	=over 4


	=item * Preloading checkboxes : Set the helper variable to the value you
	would have gotten from the control if it had been manually set as desired.

	=item * Preloading text entries : Set the helper variable to triple pipe
	separated values where each value is of the form resource-name=value

	=item * Preloading hidden fields : These cannot be pre-loaded and will always
	be pipe separated resource names.

	=back


	=back

=back	=back

=cut	=cut
Line 1823 sub start_resource {	Line 2161 sub start_resource {
$paramHash->{'toponly'} = $token->[2]{'toponly'};	$paramHash->{'toponly'} = $token->[2]{'toponly'};
$paramHash->{'addstatus'} = $token->[2]{'addstatus'};	$paramHash->{'addstatus'} = $token->[2]{'addstatus'};
$paramHash->{'addparts'} = $token->[2]{'addparts'};	$paramHash->{'addparts'} = $token->[2]{'addparts'};
	$paramHash->{'modalLink'} = $token->[2]{'modallink'};
	$paramHash->{'nocurrloc'} = $token->[2]{'nocurrloc'};
	$paramHash->{'suppressNavmap'} = $token->[2]{'suppressNavmap'};
if ($paramHash->{'addparts'}) {	if ($paramHash->{'addparts'}) {
$helper->declareVar($paramHash->{'variable'}.'_part');	$helper->declareVar($paramHash->{'variable'}.'_part');
}	}
$paramHash->{'closeallpages'} = $token->[2]{'closeallpages'};	$paramHash->{'closeallpages'} = $token->[2]{'closeallpages'};
	$paramHash->{'include_top_level_map'} = $token->[2]{'includecourse'};
return '';	return '';
}	}

Line 1915 sub start_option {	Line 2257 sub start_option {
if (!defined($paramHash->{OPTION_TEXTS})) {	if (!defined($paramHash->{OPTION_TEXTS})) {
$paramHash->{OPTION_TEXTS} = [ ];	$paramHash->{OPTION_TEXTS} = [ ];
$paramHash->{OPTION_VARS} = [ ];	$paramHash->{OPTION_VARS} = [ ];
	$paramHash->{OPTION_TYPES} = [ ];

}	}
	# We can have an attribute: type which can have the
	# values: "checkbox" or "text" which defaults to
	# checkbox allowing us to change the type of input
	# for the option:
	#
	my $input_widget_type = 'checkbox';
	if(defined($token->[2]{'type'})) {
	my $widget_type = $token->[2]{'type'};
	if ($widget_type eq 'text') { # only accept legal alternatives
	$input_widget_type = $widget_type; # Illegals are checks.
	} elsif ($widget_type eq 'hidden') {
	$input_widget_type = $widget_type;
	}
	}

# OPTION_TEXTS is a list of the text attribute	# OPTION_TEXTS is a list of the text attribute
# values used to create column headings.	# values used to create column headings.
# OPTION_VARS is a list of the variable names, used to create the checkbox	# OPTION_VARS is a list of the variable names, used to create the checkbox
# inputs.	# inputs.
	# OPTION_TYPES is a list of the option types:
	#
# We're ok with empty elements. as place holders	# We're ok with empty elements. as place holders
# Although the 'variable' element should really exist.	# Although the 'variable' element should really exist.
#	#


my $option_texts = $paramHash->{OPTION_TEXTS};	my $option_texts = $paramHash->{OPTION_TEXTS};
my $option_vars = $paramHash->{OPTION_VARS};	my $option_vars = $paramHash->{OPTION_VARS};
	my $option_types = $paramHash->{OPTION_TYPES};
push(@$option_texts, $token->[2]{'text'});	push(@$option_texts, $token->[2]{'text'});
push(@$option_vars, $token->[2]{'variable'});	push(@$option_vars, $token->[2]{'variable'});
	push(@$option_types, $input_widget_type);


# Need to create and declare the option variables as well to make them	# Need to create and declare the option variables as well to make them
# persistent.	# persistent.
Line 1972 sub render {	Line 2336 sub render {
function checkall(value, checkName) {	function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {	for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];	ele = document.forms.helpform.elements[i];
if (ele.name == checkName + '.forminput') {	if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;	document.forms.helpform.elements[i].checked=value;
}	}
}	}
Line 2004 BUTTONS	Line 2368 BUTTONS
my $multichoice = $self->{'multichoice'};	my $multichoice = $self->{'multichoice'};
my $option_vars = $self->{OPTION_VARS};	my $option_vars = $self->{OPTION_VARS};
my $option_texts = $self->{OPTION_TEXTS};	my $option_texts = $self->{OPTION_TEXTS};
	my $option_types = $self->{OPTION_TYPES};
my $addparts = $self->{'addparts'};	my $addparts = $self->{'addparts'};
	my $modalLink = $self->{'modalLink'};
my $headings_done = 0;	my $headings_done = 0;

# Evaluate the map url as needed	# Evaluate the map url as needed
Line 2044 BUTTONS	Line 2410 BUTTONS
$result .= "<th>$text</th>";	$result .= "<th>$text</th>";
}	}
}	}
$result .= "<th>Select</th>";	$result .= '<th>'.&Apache::lonlocal::mt('Select').'</th>';
$result .= "</tr><tr>"; # Close off the extra row and start a new one.	$result .= "</tr><tr>"; # Close off the extra row and start a new one.
$headings_done = 1;	$headings_done = 1;
}	}
Line 2062 BUTTONS	Line 2428 BUTTONS
my $resource_name =	my $resource_name =
HTML::Entities::encode($raw_name,"<>&\"'");	HTML::Entities::encode($raw_name,"<>&\"'");
if($option_vars) {	if($option_vars) {
	my $option_num = 0;
foreach my $option_var (@$option_vars) {	foreach my $option_var (@$option_vars) {
	my $option_type = $option_types->[$option_num];
	$option_num++;
my $var_value = "\\|\\|\\|" . $helper->{VARS}->{$option_var} .	my $var_value = "\\|\\|\\|" . $helper->{VARS}->{$option_var} .
"\\|\\|\\|";	"\\|\\|\\|";
my $checked ="";	my $checked ="";
if($var_value =~ /\Q\|\|\|$raw_name\|\|\|\E/) {	if($var_value =~ /\Q\|\|\|$raw_name\|\|\|\E/) {
$checked = "checked='checked'";	$checked = "checked='checked'";
}	}
$col .=	if ($option_type eq 'text') {
"<td align='center'><input type='checkbox' name ='$option_var".	#
".forminput' value='".	# For text's the variable value is a \|\|\| separated set of
$resource_name . "' $checked /> </td>";	# resource_name=value
	#
	my @values = split(/\\|\\|\\|/, $helper->{VARS}->{$option_var});

	# Normal practice would be to toss this in a hash but
	# the only thing that saves is the compare in the loop
	# below and for all but one case we'll break out of the loop
	# before it completes.

	my $text_value = ''; # In case there's no match.
	foreach my $value (@values) {
	my ($res, $skip) = split(/=/, $value);
	if($res eq $resource_name) {
	$text_value = $skip;
	last;
	}
	}
	# TODO: add an attribute to <option> that allows the
	# programmer to set the width of the tex entry box.

	$col .=
	"<td align='center'><input type='text' name ='$option_var".
	"_forminput' value='".$text_value."' size='5' /> </td>";
	} elsif ($option_type eq 'hidden') {
	$col .= "<td align='center'><input type='hidden' name ='$option_var".
	"_forminput' value='".
	$resource_name . "'/> </td>";
	} else {
	$col .=
	"<td align='center'><input type='$option_type' name ='$option_var".
	"_forminput' value='".
	$resource_name . "' $checked /> </td>";
	}
}	}
}	}

$col .= "<td align='center'><input type='$inputType' name='${var}.forminput' ";	$col .= "<td align='center'><input type='$inputType' name='${var}_forminput' ";
if (%defaultSymbs) {	if (%defaultSymbs) {
my $symb=$resource->symb();	my $symb=$resource->symb();
if (exists($defaultSymbs{$symb})) {	if (exists($defaultSymbs{$symb})) {
Line 2105 BUTTONS	Line 2506 BUTTONS
my $resource_name =	my $resource_name =
&HTML::Entities::encode(&$valueFunc($resource),"<>&\"'");	&HTML::Entities::encode(&$valueFunc($resource),"<>&\"'");
if ($addparts && (scalar(@{$resource->parts}) > 1)) {	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 .= "<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";	$col .= "<option value=\"$part\">".&Apache::lonlocal::mt('All Parts')."</option>\n";
foreach my $part (@{$resource->parts}) {	foreach my $part (@{$resource->parts}) {
$col .= "<option value=\"$part\">Part: $part</option>\n";	$col .= "<option value=\"$part\">".&Apache::lonlocal::mt('Part: [_1]',$part)."</option>\n";
}	}
$col .= "</select>";	$col .= "</select>";
}	}
Line 2127 BUTTONS	Line 2528 BUTTONS
}	}
}	}
function updateHidden(form,id,name) {	function updateHidden(form,id,name) {
var select=form['part_'+id+'.forminput'];	var select=form['part_'+id+'_forminput'];
var hidden=form[name+'_part.forminput'];	var hidden=form[name+'_part_forminput'];
var which=select.selectedIndex;	var which=select.selectedIndex;
hidden.value=select.options[which].value;	hidden.value=select.options[which].value;
}	}
// -->	// -->
</script>	</script>
<input type="hidden" name="${var}_part.forminput" />	<input type="hidden" name="${var}_part_forminput" />

RADIO	RADIO
$env{'form.condition'} = !$self->{'toponly'};	$env{'form.condition'} = !$self->{'toponly'};
Line 2145 RADIO	Line 2546 RADIO
push @$cols, (Apache::lonnavmaps::part_status_summary());	push @$cols, (Apache::lonnavmaps::part_status_summary());

}	}
	my $caller;
	if ($helper->{TITLE} eq 'Printing Helper') {
	$caller = 'printout';
	}
$result .=	$result .=
&Apache::lonnavmaps::render( { 'cols' => $cols,	&Apache::lonnavmaps::render( { 'cols' => $cols,
'showParts' => 0,	'showParts' => 0,
Line 2152 RADIO	Line 2557 RADIO
'resource_no_folder_link' => 1,	'resource_no_folder_link' => 1,
'closeAllPages' => $self->{'closeallpages'},	'closeAllPages' => $self->{'closeallpages'},
'suppressEmptySequences' => $self->{'suppressEmptySequences'},	'suppressEmptySequences' => $self->{'suppressEmptySequences'},
'iterator_map' => $mapUrl }	'include_top_level_map' => $self->{'include_top_level_map'},
	'iterator_map' => $mapUrl,
	'map_no_edit_link' => 1,
	'modalLink' => $modalLink,
	'nocurrloc' => $self->{'nocurrloc'},
	'suppressNavmap' => $self->{'suppressNavmap'},
	'caller' => $caller, }
);	);

$result .= $buttons;	$result .= $buttons;
Line 2167 sub postprocess {	Line 2578 sub postprocess {
$self->{ERROR_MSG} = 'You must choose at least one resource to continue.';	$self->{ERROR_MSG} = 'You must choose at least one resource to continue.';
return 0;	return 0;
}	}
	# For each of the attached options. If it's env var is undefined, set it to
	# an empty string instead.. an undef'd env var means no choices selected.
	#

	my $option_vars = $self->{OPTION_VARS};
	if ($option_vars) {
	foreach my $var (@$option_vars) {
	my $env_name = "form.".$var."_forminput";
	if (!defined($env{$env_name})) {
	$env{$env_name} = '';
	$helper->{VARS}->{$var} = '';
	}
	}
	}


if (defined($self->{NEXTSTATE})) {	if (defined($self->{NEXTSTATE})) {
$helper->changeState($self->{NEXTSTATE});	$helper->changeState($self->{NEXTSTATE});
Line 2209 selection. Defaults to false.	Line 2635 selection. Defaults to false.
If true, only active students and course personnel will be	If true, only active students and course personnel will be
shown. Defaults to false.	shown. Defaults to false.

	=item * B<sectiononly>:

	If true, and user's role is in a specific section, only course personnel
	will be shown if they also have a section-specific role in the same section.
	Defaults to false.

=item * B<emptyallowed>:	=item * B<emptyallowed>:

If true, the selection of no users is allowed. Defaults to false.	If true, the selection of no users is allowed. Defaults to false.
Line 2244 sub start_student {	Line 2676 sub start_student {
$helper->declareVar($paramHash->{'variable'});	$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};	$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
$paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};	$paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
	$paramHash->{'sectiononly'} = $token->[2]{'sectiononly'};
$paramHash->{'activeonly'} = $token->[2]{'activeonly'};	$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 2267 sub render {	Line 2700 sub render {
my $buttons = '';	my $buttons = '';
my $var = $self->{'variable'};	my $var = $self->{'variable'};

if ($self->{'multichoice'}) {
$result = <<SCRIPT;
<script type="text/javascript">
// <!--
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
if (ele.name == checkName + '.forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
}
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;
}
}
}
function getDesiredState() { // Return desired person state radio value.
numRadio = document.forms.helpform.personstate.length;
for (i =0; i < numRadio; i++) {
if (document.forms.helpform.personstate[i].checked) {
return document.forms.helpform.personstate[i].value;
}
}
return "";
}

function checksections(value) { // Check selected sections.
numSections = document.forms.helpform.chosensections.length;
desiredState = getDesiredState();

for (var option = 0; option < numSections; option++) {
if(document.forms.helpform.chosensections.options[option].selected) {
section = document.forms.helpform.chosensections.options[option].text;
if (section == "none") {
section ="";
}
for (i = 0; i < document.forms.helpform.elements.length; i++ ) {
if (document.forms.helpform.elements[i].value.indexOf(':') != -1) {
info = document.forms.helpform.elements[i].value.split(':');
hisSection = info[2];
hisState = info[4];
if (desiredState == hisState \|\|
desiredState == "All") {
if(hisSection == section \|\|
section =="" ) {
document.forms.helpform.elements[i].checked = value;
}
}
}
}
}
}
}
// -->
</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;
<br />
<table>

<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>

</table>
<br />
BUTTONS
}

if (defined $self->{ERROR_MSG}) {	if (defined $self->{ERROR_MSG}) {
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';	$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
Line 2382 BUTTONS	Line 2717 BUTTONS
%defaultUsers = map { if ($_) {($_,1) } } @defaultUsers;	%defaultUsers = map { if ($_) {($_,1) } } @defaultUsers;
delete($defaultUsers{''});	delete($defaultUsers{''});
}	}
my $choices = [];

# Load up the non-students, if necessary	my $personnel_section;
if ($self->{'coursepersonnel'}) {	if ($self->{'sectiononly'}) {
my %coursepersonnel = Apache::lonnet::get_course_adv_roles();	$personnel_section = $env{'request.course.sec'};
for (sort keys %coursepersonnel) {
for my $role (split /,/, $coursepersonnel{$_}) {
# extract the names so we can sort them
my @people;

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

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

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

# Constants	my ($course_personnel,
my $section = Apache::loncoursedata::CL_SECTION();	$current_members,
my $fullname = Apache::loncoursedata::CL_FULLNAME();	$expired_members,
my $status = Apache::loncoursedata::CL_STATUS();	$future_members) =
	&Apache::lonselstudent::get_people_in_class($env{'request.course.sec'},
# Load up the students	$personnel_section);
my $classlist = &Apache::loncoursedata::get_classlist();
my @keys = keys %{$classlist};
# Sort by: Section, name
@keys = sort {
if ($classlist->{$a}->[$section] ne $classlist->{$b}->[$section]) {
return $classlist->{$a}->[$section] cmp $classlist->{$b}->[$section];
}
return $classlist->{$a}->[$fullname] cmp $classlist->{$b}->[$fullname];
} @keys;

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

my $name = $self->{'coursepersonnel'} ? &mt('Name') : &mt('Student Name');	# Load up the non-students, if necessary
my $type = 'radio';
if ($self->{'multichoice'}) { $type = 'checkbox'; }
$result .= "<table cellspacing='2' cellpadding='2' border='0'>\n";
$result .= "<tr><td></td><td align='center'><b>$name</b></td>".
"<td align='center'><b>" . &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;	if ($self->{'coursepersonnel'}) {
for my $choice (@$choices) {	unshift @$current_members, (@$course_personnel);
$result .= "<tr><td><input type='$type' name='" .
$self->{'variable'} . '.forminput' . "'";

if (%defaultUsers) {
my $user=$choice->[0];
if (exists($defaultUsers{$user})) {
$result .= " checked='checked' ";
$checked = 1;
}
} elsif (!$self->{'multichoice'} && !$checked) {
$result .= " checked='checked' ";
$checked = 1;
}
$result .=
" value='" . HTML::Entities::encode($choice->[0] . ':'
.$choice->[2] . ':'
.$choice->[1] . ':'
.$choice->[3], "<>&\"'")
. "' /></td><td>"
. HTML::Entities::encode($choice->[1],'<>&"')
. "</td><td align='center'>"
. HTML::Entities::encode($choice->[2],'<>&"')
. "</td>\n<td>"
. HTML::Entities::encode($choice->[3],'<>&"')
. "</td>\n<td>"
. HTML::Entities::encode($choice->[4],'<>&"')
. "</td>\n<td>"
. HTML::Entities::encode($choice->[0],'<>&"')
. "</td></tr>\n";
}	}

$result .= "</table>\n\n";	my %titles = &Apache::lonlocal::texthash(
$result .= $buttons;	'active' => 'Select Currently Enrolled Students and Active Course Personnel',
	'future' => 'Select Future Enrolled Students',
	'expired' => 'Select Previously Enrolled Students',
	);

	if ($env{'request.course.sec'}) {
	if ($self->{'sectiononly'}) {
	$titles{'active'} = &mt('Select Currently Enrolled Students and Active Course Personnel in Section: [_1]',
	$env{'request.course.sec'});
	} else {
	$titles{'active'} = &mt('Select Currently Enrolled Students in Section: [_1], and Active Course Personnel',
	$env{'request.course.sec'});
	}
	$titles{'future'} = &mt('Select Future Enrolled Students in Section: [_1]',
	$env{'request.course.sec'});
	$titles{'expired'} = &mt('Select Previously Enrolled Students in Section: [_1]',
	$env{'request.course.sec'});
	}

	# Current personnel

	$result .= '<h4>'.$titles{'active'}.'</h4>';
	$result .= &Apache::lonselstudent::render_student_list( $current_members,
	"helpform",
	"current",
	\%defaultUsers,
	$self->{'multichoice'},
	$self->{'variable'},
	1);

	# If activeonly is not set then we can also give the expired students:
#	#
# now add the fancy section choice... first enumerate the sections:	if (!$self->{'activeonly'} && ((scalar(@$future_members)) > 0)) {
if ($self->{'multichoice'}) {
my %sections;	# And future.
for my $key (@keys) {
my $section_name = $classlist->{$key}->[$section];	$result .= '<h4>'.$titles{'future'}.'</h4>';
if ($section_name ne "") {
$sections{$section_name} = 1;	$result .= &Apache::lonselstudent::render_student_list( $future_members,
}	"helpform",
}	"future",
# The variable $choice_widget will have the html to make the choice	\%defaultUsers,
# selector.	$self->{'multichoice'},
my $size=5;	$self->{'variable'},
if (scalar(keys(%sections)) < 5) {	0);
$size=scalar(keys(%sections));	}
}	if (!$self->{'activeonly'} && ((scalar(@$expired_members)) > 0)) {
my $choice_widget = '<select multiple name="chosensections" size="'.$size.'">'."\n";	# Past
foreach my $sec (sort {lc($a) cmp lc($b)} (keys(%sections))) {
$choice_widget .= "<option name=\"$sec\">$sec</option>\n";	$result .= '<h4>'.$titles{'expired'}.'</h4>';
}	$result .= &Apache::lonselstudent::render_student_list($expired_members,
$choice_widget .= "<option>none</option></select>\n";	"helpform",
	"past",
# Build a table without any borders to contain the section based	\%defaultUsers,
# selection:	$self->{'multichoice'},
	$self->{'variable'},
my $section_selectors =<<SECTIONSELECT;	0);
<table border="0">
<tr valign="top">
<td>For Sections:</td><td>$choice_widget</td>
<td><label><input type="radio" name="personstate" value="Active" checked />
Current Students</label></td>
<td><label><input type="radio" name="personstate" value="All" />
All students</label></td>
<td><label><input type="radio" name="personstate" value="Expired" />
Expired Students</label></td>
</tr>
<tr>
<td><input type="button" value="Select" onclick="checksections(true);" /></td>
<td><input type="button" value="Unselect" onclick="checksections(false);" /></td></tr>
</table>
<br />
SECTIONSELECT
$result .= $section_selectors;
}	}



return $result;	return $result;
}	}

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 && !$self->{'emptyallowed'}) {	if (!$result && !$self->{'emptyallowed'}) {
if ($self->{'coursepersonnel'}) {	if ($self->{'coursepersonnel'}) {
$self->{ERROR_MSG} =	$self->{ERROR_MSG} =
Line 2712 sub render {	Line 2989 sub render {
function checkall(value, checkName) {	function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {	for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];	ele = document.forms.helpform.elements[i];
if (ele.name == checkName + '.forminput') {	if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;	document.forms.helpform.elements[i].checked=value;
}	}
}	}
Line 2751 BUTTONS	Line 3028 BUTTONS
}	}

# Get the list of files in this directory.	# Get the list of files in this directory.
my @fileList;	my (@fileList,$listref,$listerror);

# If the subdirectory is in local CSTR space	# If the subdirectory is in local CSTR space
my $metadir;	my $metadir;
if ($subdir =~ m\|/home/([^/]+)/public_html/(.*)\|) {	my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
my ($user,$domain)=	if ($subdir =~ m{^(?:\Q$londocroot\E)/priv/[^/]+/[^/]+/(.)$}) {
&Apache::loncacc::constructaccess($subdir,	my $innerpath=$1;
$Apache::lonnet::perlvar{'lonDefDomain'});	unless ($subdir=~m{^\Q$londocroot\E}) {
$metadir='/res/'.$domain.'/'.$user.'/'.$2;	$subdir=$londocroot.$subdir;
@fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');	}
} elsif ($subdir =~ m\|^~([^/]+)/(.*)$\|) {
$subdir='/home/'.$1.'/public_html/'.$2;
my ($user,$domain)=	my ($user,$domain)=
&Apache::loncacc::constructaccess($subdir,	&Apache::lonnet::constructaccess($subdir);
$Apache::lonnet::perlvar{'lonDefDomain'});	$metadir='/res/'.$domain.'/'.$user.'/'.$innerpath;
$metadir='/res/'.$domain.'/'.$user.'/'.$2;	($listref,$listerror) =
@fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');	&Apache::lonnet::dirlist($subdir,$domain,$user,undef,undef,'/');
} else {	} else {
# local library server resource space	# local library server resource space
@fileList = &Apache::lonnet::dirlist($subdir, $env{'user.domain'}, $env{'user.name'}, '');	($listref,$listerror) =
	&Apache::lonnet::dirlist($subdir,$env{'user.domain'},$env{'user.name'},undef,undef,'/');
}	}

# Sort the fileList into order	# Sort the fileList into order
@fileList = sort {lc($a) cmp lc($b)} @fileList;	if (ref($listref) eq 'ARRAY') {
	@fileList = sort {lc($a) cmp lc($b)} @{$listref};
	}

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

Line 2829 BUTTONS	Line 3107 BUTTONS
my $id = &new_id();	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' ".qq{id="$id"}." 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="checked"';	$result .= ' checked="checked"';
Line 2869 sub fileState {	Line 3147 sub fileState {
}	}
my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};	my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
my $subdirpart = $constructionSpaceDir;	my $subdirpart = $constructionSpaceDir;
$subdirpart =~ s/^\/home\/$uname\/public_html//;	$subdirpart =~ s{^\Q$docroot/priv/$udom/$uname\E}{};
my $resdir = $docroot . '/res/' . $udom . '/' . $uname .	my $resdir = $docroot . '/res/' . $udom . '/' . $uname .
$subdirpart;	$subdirpart;

Line 2890 sub fileState {	Line 3168 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 2915 package Apache::lonhelper::section;	Line 3193 package Apache::lonhelper::section;
<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.

It takes the standard attributes "variable", "multichoice", and	It takes the standard attributes "variable", "multichoice",
"nextstate", meaning what they do for most other elements.	"allowempty" and "nextstate", meaning what they do for most other
	elements.

	also takes a boolean 'onlysections' which will restrict this to only
	have sections and not include groups

=cut	=cut

Line 2946 sub start_section {	Line 3228 sub start_section {
$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->{'allowempty'} = $token->[2]{'allowempty'};
if (defined($token->[2]{'nextstate'})) {	if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};	$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}	}

# Populate the CHOICES element	# Populate the CHOICES element
my %choices;	my %choices;
	my $usersec = $Apache::lonnet::env{'request.course.sec'};

my $section = Apache::loncoursedata::CL_SECTION();	if ($usersec ne '') {
my $classlist = Apache::loncoursedata::get_classlist();	$choices{$usersec} = $usersec;
foreach (keys %$classlist) {	} else {
my $sectionName = $classlist->{$_}->[$section];	my $section = Apache::loncoursedata::CL_SECTION();
if (!$sectionName) {	my $classlist = Apache::loncoursedata::get_classlist();
$choices{"No section assigned"} = "";	foreach my $user (keys(%$classlist)) {
} else {	my $section_name = $classlist->{$user}[$section];
$choices{$sectionName} = $sectionName;	if (!$section_name) {
	$choices{"No section assigned"} = "";
	} else {
	$choices{$section_name} = $section_name;
	}
}	}
}
	if (exists($choices{"No section assigned"})) {
for my $sectionName (sort(keys(%choices))) {	push(@{$paramHash->{CHOICES}},
	['No section assigned','No section assigned']);
push @{$paramHash->{CHOICES}}, [$sectionName, $sectionName];	delete($choices{"No section assigned"});
	}
	}
	for my $section_name (sort {lc($a) cmp lc($b) } (keys(%choices))) {
	push @{$paramHash->{CHOICES}}, [$section_name, $section_name];
	}
	return if ($token->[2]{'onlysections'});

	# add in groups to the end of the list
	my %curr_groups = &Apache::longroup::coursegroups();
	foreach my $group_name (sort(keys(%curr_groups))) {
	push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}	}
}	}

Line 2986 package Apache::lonhelper::group;	Line 3285 package Apache::lonhelper::group;

=head2 Element: groupX<group, helper element>	=head2 Element: groupX<group, helper element>

<section> allows the user to choose one or more groups from the current course.	<group> allows the user to choose one or more groups from the current course.

	It takes the standard attributes "variable", "multichoice",
	"allowempty" and "nextstate", meaning what they do for most other
	elements.

	also takes a boolean grouponly, which if true, will restrict choice to
	groups in which user is a member, unless user has the mdg priv in the course,
	in which case all groups will be possible choices. Defaults to false.

It takes the standard attributes "variable", "multichoice", and "nextstate", meaning what they do for most other elements.

=cut	=cut

no strict;	no strict;
Line 3018 sub start_group {	Line 3323 sub start_group {
$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->{'allowempty'} = $token->[2]{'allowempty'};
	$paramHash->{'grouponly'} = $token->[2]{'grouponly'};
if (defined($token->[2]{'nextstate'})) {	if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};	$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}	}
Line 3025 sub start_group {	Line 3332 sub start_group {
# Populate the CHOICES element	# Populate the CHOICES element
my %choices;	my %choices;

my $numgroups;
my %curr_groups;	my %curr_groups;
if (&Apache::loncommon::coursegroups(\%curr_groups)) {	if ((!$paramHash->{'grouponly'}) \|\| (&Apache::lonnet::allowed('mdg',$Apache::lonnet::env{'request.course.id'}))) {
foreach my $group_name (keys %curr_groups) {	%curr_groups = &Apache::longroup::coursegroups();
$choices{$group_name} = $group_name;	} elsif ($Apache::lonnet::env{'request.course.groups'} ne '') {
}	map { $curr_groups{$_} = 1; } split(/:/,$Apache::lonnet::env{'request.course.groups'});
}	}
foreach my $group_name (sort(keys(%choices))) {	foreach my $group_name (sort {lc($a) cmp lc($b)} (keys(%curr_groups))) {
push @{$paramHash->{CHOICES}}, [$group_name, $group_name];	push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}	}
}	}

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

Line 3056 package Apache::lonhelper::string;	Line 3362 package Apache::lonhelper::string;
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
also pass through 'maxlength' and 'size' attributes to the input tag.	also pass through 'maxlength' and 'size' attributes to the input tag.
	Since you could have multiple strings in a helper state, each with its own
	validator, all but the last string should have
	noproceed='1' so that _all_ validators are evaluated before the next
	state can be reached.

string honors the defaultvalue tag, if given.	string honors the defaultvalue tag, if given.

Line 3075 BEGIN {	Line 3385 BEGIN {

sub new {	sub new {
my $ref = Apache::lonhelper::element->new();	my $ref = Apache::lonhelper::element->new();
	$ref->{'PROCEED'} = 1; # By default postprocess goes to next state.
bless($ref);	bless($ref);
}	}

Line 3091 sub start_string {	Line 3402 sub start_string {
$paramHash->{'nextstate'} = $token->[2]{'nextstate'};	$paramHash->{'nextstate'} = $token->[2]{'nextstate'};
$paramHash->{'maxlength'} = $token->[2]{'maxlength'};	$paramHash->{'maxlength'} = $token->[2]{'maxlength'};
$paramHash->{'size'} = $token->[2]{'size'};	$paramHash->{'size'} = $token->[2]{'size'};

return '';	return '';
}	}

sub end_string {	sub end_string {
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::string->new();	my $state = Apache::lonhelper::string->new();


	if(&Apache::lonxml::get_param('noproceed', $parstack, $safeeval, undef, 1)) {
	$state->noproceed();
	}



return '';	return '';
}	}

	sub noproceed() {
	my $self = shift;
	$self->{PROCEED} = 0;
	}

sub render {	sub render {
my $self = shift;	my $self = shift;
my $result = '';	my $result = '';
Line 3113 sub render {	Line 3437 sub render {
$result .= '<p><font color="#FF0000">' . $self->{ERROR_MSG} . '</font></p>';	$result .= '<p><font color="#FF0000">' . $self->{ERROR_MSG} . '</font></p>';
}	}

$result .= '<input type="string" name="' . $self->{'variable'} . '.forminput"';	$result .= '<input type="text" name="' . $self->{'variable'} . '_forminput"';

if (defined($self->{'size'})) {	if (defined($self->{'size'})) {
$result .= ' size="' . $self->{'size'} . '"';	$result .= ' size="' . $self->{'size'} . '"';
Line 3140 sub postprocess {	Line 3464 sub postprocess {

if (defined($self->{VALIDATOR})) {	if (defined($self->{VALIDATOR})) {
my $validator = eval($self->{VALIDATOR});	my $validator = eval($self->{VALIDATOR});
die 'Died during evaluation of evaulation code; Perl said: ' . $@ if $@;	die 'Died during evaluation of validator code; Perl said: ' . $@ if $@;
my $invalid = &$validator($helper, $state, $self, $self->getValue());	my $invalid = &$validator($helper, $state, $self, $self->getValue());
if ($invalid) {	if ($invalid) {
$self->{ERROR_MSG} = $invalid;	$self->{ERROR_MSG} = $invalid;
Line 3148 sub postprocess {	Line 3472 sub postprocess {
}	}
}	}

if (defined($self->{'nextstate'})) {	if (defined($self->{'nextstate'}) && $self->{PROCEED}) {
$helper->changeState($self->{'nextstate'});	$helper->changeState($self->{'nextstate'});
}	}

Line 3246 sub start_clause {	Line 3570 sub start_clause {
die 'Error in clause of condition, Perl said: ' . $@ if $@;	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);	my $end_tag = $paramHash->{SKIPTAG} \|\| '/condition';
	&Apache::lonxml::get_all_text($end_tag, $parser);
}	}
}	}

Line 3305 snippets and collecting the results. Fin	Line 3630 snippets and collecting the results. Fin
helper, going to a provided page.	helper, going to a provided page.

If the parameter "restartCourse" is true, this will override the buttons and	If the parameter "restartCourse" is true, this will override the buttons and
will make a "Finish Helper" button that will re-initialize the course for them,	will make a Save button (Finish Helper) that will re-initialize the course for them,
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.

Line 3374 sub render {	Line 3699 sub render {
my @results;	my @results;

# Collect all the results	# Collect all the results
for my $stateName (keys %{$helper->{STATES}}) {	for my $stateName (keys(%{$helper->{STATES}})) {
my $state = $helper->{STATES}->{$stateName};	my $state = $helper->{STATES}->{$stateName};

for my $element (@{$state->{ELEMENTS}}) {	for my $element (@{$state->{ELEMENTS}}) {
Line 3412 sub render {	Line 3737 sub render {

my $actionURL = $self->{EXIT_PAGE};	my $actionURL = $self->{EXIT_PAGE};
my $targetURL = '';	my $targetURL = '';
my $finish=&mt('Finish');	my $finish=&mt('Save');
if ($self->{'restartCourse'}) {	if ($self->{'restartCourse'}) {
$actionURL = '/adm/roles';	$actionURL = '/adm/roles';
$targetURL = '/adm/menu';	$targetURL = '/adm/menu';
Line 3424 sub render {	Line 3749 sub render {
if ($env{'course.'.$env{'request.course.id'}.'.clonedfrom'}) {	if ($env{'course.'.$env{'request.course.id'}.'.clonedfrom'}) {
$targetURL = '/adm/parmset?overview=1';	$targetURL = '/adm/parmset?overview=1';
}	}
my $finish=&mt('Finish Course Initialization');
}	}
my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');	my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');	my $next = HTML::Entities::encode(&mt("Next"), '<>&"');
my $target = " target='loncapaclient'";	$result .= "<p>\n" .
if (($env{'browser.interface'} eq 'textual') \|\|	"<form action='".$actionURL."' method='post' >\n" .
($env{'environment.remote'} eq 'off')) { $target=''; }
$result .= "<center>\n" .
"<form action='".$actionURL."' method='post' $target>\n" .
"<input type='button' onclick='history.go(-1)' value='$previous' />" .	"<input type='button' onclick='history.go(-1)' value='$previous' />" .
"<input type='hidden' name='orgurl' value='$targetURL' />" .	"<input type='hidden' name='orgurl' value='$targetURL' />" .
"<input type='hidden' name='selectrole' value='1' />\n" .	"<input type='hidden' name='selectrole' value='1' />\n" .
"<input type='hidden' name='" . $env{'request.role'} .	"<input type='hidden' name='" . $env{'request.role'} .
"' value='1' />\n<input type='submit' value='" . $finish . "' />\n" .	"' value='1' />\n<input type='submit' value='" . $finish . "' />\n" .
"</form></center>";	"</form></p>\n";

return $result;	return $result;
}	}
Line 3451 sub overrideForm {	Line 3772 sub overrideForm {

package Apache::lonhelper::parmwizfinal;	package Apache::lonhelper::parmwizfinal;

# This is the final state for the parmwizard. It is not generally useful,	# This is the final state for the parm helper. It is not generally useful,
# so it is not perldoc'ed. It does its own processing.	# so it is not perldoc'ed. It does its own processing.
# It is represented with <parmwizfinal />, and	# It is represented with <parmwizfinal />, and
# should later be moved to lonparmset.pm .	# should later be moved to lonparmset.pm .
Line 3517 sub render {	Line 3838 sub render {

# 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>'.&mt('for <b>all resources in the course</b>').'</li>';	$resourceString .= '<li>'.&mt('for [_1]all resources in the course[_2]','<b>','</b>').'</li>';
if ($vars->{TARGETS} eq 'course') {	if ($vars->{TARGETS} eq 'course') {
$level = 11; # general course, see lonparmset.pm perldoc	$level = 14; # general course, see lonparmset.pm perldoc
} elsif ($vars->{TARGETS} eq 'section') {	} elsif ($vars->{TARGETS} eq 'section') {
	$level = 9;
	} elsif ($vars->{TARGETS} eq 'group') {
$level = 6;	$level = 6;
} else {	} else {
$level = 3;	$level = 3;
Line 3530 sub render {	Line 3853 sub render {
$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();
my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});	if (defined($navmap)) {
my $title = $res->compTitle();	my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
$symb = $res->symb();	my $title = $res->compTitle();
$resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';	$symb = $res->symb();
	$resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
	} else {
	$resourceString .= '<li>'.&mt('for the map ID [_1] (name unavailable)','<b>'.$vars->{RESOURCE_ID}.'</b>').'</li>';
	&Apache::lonnet::logthis('Retrieval of map title failed in lonhelper.pm - could not create navmap object for course.');

	}
if ($vars->{TARGETS} eq 'course') {	if ($vars->{TARGETS} eq 'course') {
$level = 10; # general course, see lonparmset.pm perldoc	$level = 13; # general course, see lonparmset.pm perldoc
} elsif ($vars->{TARGETS} eq 'section') {	} elsif ($vars->{TARGETS} eq 'section') {
	$level = 8;
	} elsif ($vars->{TARGETS} eq 'group') {
$level = 5;	$level = 5;
} else {	} else {
$level = 2;	$level = 2;
Line 3544 sub render {	Line 3875 sub render {
$affectedResourceId = $vars->{RESOURCE_ID};	$affectedResourceId = $vars->{RESOURCE_ID};
$paramlevel = 'map';	$paramlevel = 'map';
} else {	} else {
my $navmap = Apache::lonnavmaps::navmap->new();
my $res = $navmap->getById($vars->{RESOURCE_ID});
my $part = $vars->{RESOURCE_ID_part};	my $part = $vars->{RESOURCE_ID_part};
if ($part ne 'All Parts' && $part) { $parm_name=~s/^0/$part/; } else { $part=&mt('All Parts'); }	if ($part ne 'All Parts' && $part) { $parm_name=~s/^0/$part/; } else { $part=&mt('All Parts'); }
$symb = $res->symb();	my $navmap = Apache::lonnavmaps::navmap->new();
my $title = $res->compTitle();	if (defined($navmap)) {
$resourceString .= '<li>'.&mt('for the resource named [_1] part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';	my $res = $navmap->getById($vars->{RESOURCE_ID});
	$symb = $res->symb();
	my $title = $res->compTitle();
	$resourceString .= '<li>'.&mt('for the resource named [_1], part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
	} else {
	$resourceString .= '<li>'.&mt('for the resource ID [_1] (name unavailable), part [_2]','<b>'.$vars->{RESOURCE_ID}.'</b>',"<b>$part</b>").'</li>';
	&Apache::lonnet::logthis('Retrieval of resource title failed in lonhelper.pm - could not create navmap object for course.');
	}
if ($vars->{TARGETS} eq 'course') {	if ($vars->{TARGETS} eq 'course') {
$level = 7; # general course, see lonparmset.pm perldoc	$level = 10; # general course, see lonparmset.pm perldoc
} elsif ($vars->{TARGETS} eq 'section') {	} elsif ($vars->{TARGETS} eq 'section') {
	$level = 7;
	} elsif ($vars->{TARGETS} eq 'group') {
$level = 4;	$level = 4;
} else {	} else {
$level = 1;	$level = 1;
Line 3562 sub render {	Line 3900 sub render {
$paramlevel = 'full';	$paramlevel = 'full';
}	}

my $result = "<form name='helpform' method='POST' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";	my $result = "<form name='helpform' method='post' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";
$result .= "<input type='hidden' name='action' value='settable' />\n";	$result .= "<input type='hidden' name='action' value='settable' />\n";
$result .= "<input type='hidden' name='dis' value='helper' />\n";	$result .= "<input type='hidden' name='dis' value='helper' />\n";
$result .= "<input type='hidden' name='pscat' value='".	$result .= "<input type='hidden' name='pscat' value='".
Line 3579 sub render {	Line 3917 sub render {
$result .= "<input type='hidden' name='psprt' value='".	$result .= "<input type='hidden' name='psprt' value='".
HTML::Entities::encode($part,"'<>&\"") . "' />\n";	HTML::Entities::encode($part,"'<>&\"") . "' />\n";

$result .= '<p>'.&mt('Confirm that this information is correct, then click "Finish Helper" to complete setting the parameter.').'<ul>';	$result .= '<p class="LC_info">'
	.&mt('Confirm that this information is correct, then click "Save" to complete setting the parameter.')
	.'</p>'
	.'<ul>';

# Print the type of manipulation:	# Print the type of manipulation:
my $extra;	my $extra;
Line 3627 sub render {	Line 3968 sub render {

# Print targets	# Print targets
if ($vars->{TARGETS} eq 'course') {	if ($vars->{TARGETS} eq 'course') {
$result .= '<li>'.&mt('for <b>all students in course</b>').'</li>';	$result .= '<li>'.&mt('for [_1]all students in course[_2]','<b>','</b>').'</li>';
} elsif ($vars->{TARGETS} eq 'section') {	} elsif ($vars->{TARGETS} eq 'section') {
my $section = $vars->{SECTION_NAME};	my $section = $vars->{SECTION_NAME};
$result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';	$result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';
Line 3652 sub render {	Line 3993 sub render {

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

	$result .= '</ul>';

	# FIXME: Make previous button working
	# Found to be dysfunctional when used to change the selected student
	# my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
	my $buttons .= '<p><span class="LC_nobreak">'
	# .'<input name="back" type="button"'
	# .' value="'.$previous.'" onclick="history.go(-1)" />'
	.' <input type="submit" value="'.&mt('Save').'" />' # Finish Helper
	.'</span></p>'."\n";

# print pres_marker	# print pres_marker
$result .= "\n<input type='hidden' name='pres_marker'" .	$result .= "\n<input type='hidden' name='pres_marker'" .
" value='$affectedResourceId&$parm_name&$level' />\n";	" value='$affectedResourceId&$parm_name&$level' />\n";
Line 3664 sub render {	Line 4017 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='".&mt('Finish Helper')."' /></center></form>\n";	$result .= $buttons;

return $result;	return $result;
}	}

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

Removed from v.1.128
changed lines
	Added in v.1.197.2.2.2.2