--- loncom/interface/lonhelper.pm 2006/05/09 22:15:30 1.146
+++ loncom/interface/lonhelper.pm 2022/06/27 20:35:51 1.204
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# .helper XML handler to implement the LON-CAPA helper
#
-# $Id: lonhelper.pm,v 1.146 2006/05/09 22:15:30 foxr Exp $
+# $Id: lonhelper.pm,v 1.204 2022/06/27 20:35:51 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -64,9 +64,11 @@ messages, resource selections, or date q
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
-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
-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
@@ -81,25 +83,28 @@ State tags are also required to have an
human name of the state, and will be displayed as the header on top of
the screen for the user.
+State tags may also optionally have an attribute "help" which should be
+the filename of a help file, this will add a blue ? to the title.
+
=head2 Example Helper Skeleton
An example of the tags so far:
<helper title="Example Helper">
<state name="START" title="Demonstrating the Example Helper">
- <!-- notice this is the START state the wizard requires -->
+ <!-- notice this is the START state the helper requires -->
</state>
<state name="GET_NAME" title="Enter Student Name">
</state>
</helper>
-Of course this does nothing. In order for the wizard to do something, it is
-necessary to put actual elements into the wizard. Documentation for each
+Of course this does nothing. In order for the helper to do something, it is
+necessary to put actual elements into the helper. Documentation for each
of these elements follows.
=head1 Creating a Helper With Code, Not XML
-In some situations, such as the printing wizard (see lonprintout.pm),
+In some situations, such as the printing helper (see lonprintout.pm),
writing the helper in XML would be too complicated, because of scope
issues or the fact that the code actually outweighs the XML. It is
possible to create a helper via code, though it is a little odd.
@@ -183,7 +188,11 @@ use Apache::File;
use Apache::lonxml;
use Apache::lonlocal;
use Apache::lonnet;
+use Apache::longroup;
+use Apache::lonselstudent;
+
+use LONCAPA;
# Register all the tags with the helper, so the helper can
# push and pop them
@@ -254,7 +263,7 @@ sub real_handler {
my $uri = shift;
if (!defined($uri)) { $uri = $r->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 $file;
read $fh, $file, 100000000;
@@ -276,7 +285,8 @@ sub real_handler {
my $allowed = $helper->allowedCheck();
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.";
return HTTP_NOT_ACCEPTABLE;
}
@@ -332,7 +342,8 @@ sub start_state {
}
Apache::lonhelper::state->new($token->[2]{'name'},
- $token->[2]{'title'});
+ $token->[2]{'title'},
+ $token->[2]{'help'});
return '';
}
@@ -362,6 +373,7 @@ use Apache::loncommon;
use Apache::File;
use Apache::lonlocal;
use Apache::lonnet;
+use LONCAPA;
sub new {
my $proto = shift;
@@ -467,9 +479,8 @@ sub _saveVars {
sub _varsInFile {
my $self = shift;
my @vars = ();
- for my $key (keys %{$self->{VARS}}) {
- push @vars, &Apache::lonnet::escape($key) . '=' .
- &Apache::lonnet::escape($self->{VARS}->{$key});
+ for my $key (keys(%{$self->{VARS}})) {
+ push(@vars, &escape($key) . '=' . &escape($self->{VARS}->{$key}));
}
return join ('&', @vars);
}
@@ -484,7 +495,7 @@ sub declareVar {
$self->{VARS}->{$var} = '';
}
- my $envname = 'form.' . $var . '.forminput';
+ my $envname = 'form.' . $var . '_forminput';
if (defined($env{$envname})) {
if (ref($env{$envname})) {
$self->{VARS}->{$var} = join('|||', @{$env{$envname}});
@@ -500,8 +511,13 @@ sub allowedCheck {
if (!defined($self->{REQUIRED_PRIV})) {
return 1;
}
-
- return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $env{'request.course.id'});
+ my ($priv,$modifier) = split(/\&/,$self->{REQUIRED_PRIV});
+ 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 {
@@ -523,7 +539,7 @@ sub process {
# Phase 1: Post processing for state of previous screen (which is actually
# the "current state" in terms of the helper variables), if it wasn't the
# beginning state.
- if ($self->{STATE} ne "START" || $env{"form.SUBMIT"} eq &mt("Next ->")) {
+ if ($self->{STATE} ne "START" || $env{"form.SUBMIT"} eq &mt("Next")) {
my $prevState = $self->{STATES}{$self->{STATE}};
$prevState->postprocess();
}
@@ -563,7 +579,7 @@ sub process {
# 4: Render the current state to the screen as an HTML page.
sub display {
my $self = shift;
-
+ my $footer = shift;
my $state = $self->{STATES}{$self->{STATE}};
my $result = "";
@@ -575,84 +591,85 @@ sub display {
# Phase 4: Display.
my $stateTitle=&mt($state->title());
+ my $stateHelp= $state->help();
my $browser_searcher_js =
'<script type="text/javascript">'."\n".
&Apache::loncommon::browser_and_searcher_javascript().
"\n".'</script>';
- $result .= &Apache::loncommon::start_page($self->{TITLE},
- $browser_searcher_js);
-
- my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
- my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
- # FIXME: This should be parameterized, not concatenated - Jeremy
+ # 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,});
- if (!$state->overrideForm()) { $result.="<form name='helpform' method='POST'>"; }
- $result .= <<HEADER;
- <table border="0" width='100%'><tr><td>
- <h2><i>$stateTitle</i></h2>
-HEADER
+ my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
+ my $next = HTML::Entities::encode(&mt("Next"), '<>&"');
+ # FIXME: This should be parameterized, not concatenated - Jeremy
- $result .= "<table cellpadding='10' width='100%'><tr><td rowspan='2' valign='top'>";
- if (!$state->overrideForm()) {
- $result .= $self->_saveVars();
+ if (!$state->overrideForm()) { $result.='<form name="helpform" method="post" action="">'; }
+ if ($stateHelp) {
+ $stateHelp = &Apache::loncommon::help_open_topic($stateHelp);
}
- $result .= $state->render();
-
- $result .= "</td><td valign='top' align='right'>";
- # Warning: Copy and pasted from below, because it's too much trouble to
- # turn this into a subroutine
+ # Prepare buttons
+ my $buttons;
if (!$state->overrideForm()) {
if ($self->{STATE} ne $self->{START_STATE}) {
#$result .= '<input name="SUBMIT" type="submit" value="<- Previous" /> ';
}
+ $buttons = '<p>'; # '<fieldset>';
if ($self->{DONE}) {
my $returnPage = $self->{RETURN_PAGE};
- $result .= "<a href=\"$returnPage\">" . &mt("End Helper") . "</a>";
+ $buttons .= '<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>';
+ $buttons .= '<span class="LC_nobreak">'
+ .'<input name="back" type="button" '
+ .'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 ($self->{STATE} ne $self->{START_STATE}) {
- #$result .= '<input name="SUBMIT" type="submit" value="<- Previous" /> ';
- }
- if ($self->{DONE}) {
- my $returnPage = $self->{RETURN_PAGE};
- $result .= "<a href=\"$returnPage\">" . &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 .= $self->_saveVars();
}
+ $result .= $state->render();
+
+ # Bottom buttons
+ $result .= $buttons;
- #foreach my $key (keys %{$self->{VARS}}) {
+
+ #foreach my $key (keys(%{$self->{VARS}})) {
# $result .= "|$key| -> " . $self->{VARS}->{$key} . "<br />";
#}
- $result .= "</td></tr></table>";
+# $result .= '</div>';
$result .= <<FOOTER;
- </td>
- </tr>
- </table>
</form>
FOOTER
- $result .= &Apache::loncommon::end_page();
+ $result .= $footer.&Apache::loncommon::end_page();
# Handle writing out the vars to the file
my $file = Apache::File->new('>'.$self->{FILENAME});
print $file $self->_varsInFile();
@@ -678,6 +695,7 @@ sub new {
$self->{NAME} = shift;
$self->{TITLE} = shift;
+ $self->{HELP} = shift;
$self->{ELEMENTS} = [];
bless($self, $class);
@@ -699,6 +717,11 @@ sub title {
return $self->{TITLE};
}
+sub help {
+ my $self = shift;
+ return $self->{HELP};
+}
+
sub preprocess {
my $self = shift;
for my $element (@{$self->{ELEMENTS}}) {
@@ -790,7 +813,7 @@ the element. How this value is interpret
the element itself, and possibly the settings the element has (such as
multichoice vs. single choice for <choices> tags).
-This is also intended for things like the course initialization wizard, where the
+This is also intended for things like the course initialization helper, where the
user is setting various parameters. By correctly grabbing current settings
and including them into the helper, it allows the user to come back to the
helper later and re-execute it, without needing to worry about overwriting
@@ -992,6 +1015,9 @@ sub start_message {
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
+ if (defined($token->[2]{'type'})) {
+ $paramHash->{TYPE} = $token->[2]{'type'};
+ }
return '';
}
@@ -1007,8 +1033,16 @@ sub end_message {
sub render {
my $self = shift;
-
- return &mtn($self->{MESSAGE_TEXT});
+
+ if ($self->{TYPE} =~ /^\s*warning\s*$/i) {
+ $self->{MESSAGE_TEXT} =
+ '<span class="LC_warning">'. $self->{MESSAGE_TEXT}.'</span>';
+ }
+ if ($self->{TYPE} =~ /^\s*error\s*$/i) {
+ $self->{MESSAGE_TEXT} =
+ '<span class="LC_error">'. $self->{MESSAGE_TEXT}.'</span>';
+ }
+ return $self->{MESSAGE_TEXT};
}
# If a NEXTSTATE was given, switch to it
sub postprocess {
@@ -1021,6 +1055,175 @@ sub postprocess {
}
1;
+package Apache::lonhelper::helpicon;
+
+=pod
+
+=head1 Elements
+
+=head2 Element: helpiconX<helpicon, helper element>
+
+Helpicon elements add a help icon at the current location.
+Example:
+
+ <helpicon file="Help">
+ General Help
+ </helpicon>
+
+In this example will generate a help icon to the Help.hlp url with a
+description of 'General Help'. The description is not required and if
+left out (Example: <helpicon file="Help" /> only the icon will be
+added.)
+
+=head3 Localization
+
+The description text will be run through the normalize_string function
+and that will be used as a call to &mt.
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+use Apache::lonlocal;
+
+BEGIN {
+ &Apache::lonhelper::register('Apache::lonhelper::helpicon',
+ ('helpicon'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::element->new();
+ bless($ref);
+}
+
+# CONSTRUCTION: Construct the message element from the XML
+sub start_helpicon {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+
+ $paramHash->{HELP_TEXT} = &mtn(&Apache::lonxml::get_all_text('/helpicon',
+ $parser));
+
+ $paramHash->{HELP_TEXT} =~s/^\s+//;
+ $paramHash->{HELP_TEXT} =~s/\s+$//;
+
+ if (defined($token->[2]{'file'})) {
+ $paramHash->{HELP_FILE} = $token->[2]{'file'};
+ }
+ return '';
+}
+
+sub end_helpicon {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ Apache::lonhelper::helpicon->new();
+ return '';
+}
+
+sub render {
+ my $self = shift;
+
+ my $text;
+ if ( $self->{HELP_TEXT} ne '') {
+ $text=&mtn($self->{HELP_TEXT});
+ }
+
+ return &Apache::loncommon::help_open_topic($self->{HELP_FILE},
+ $text);
+}
+sub postprocess {
+ my $self = shift;
+ if (defined($self->{NEXTSTATE})) {
+ $helper->changeState($self->{NEXTSTATE});
+ }
+
+ return 1;
+}
+
+1;
+
+package Apache::lonhelper::skip;
+
+=pod
+
+=head1 Elements
+
+=head2 Element: skipX<skip>
+
+The <skip> tag allows you define conditions under which the current state
+should be skipped over and define what state to skip to.
+
+ <state name="SKIP">
+ <skip>
+ <clause>
+ #some code that decides whether to skip the state or not
+ </clause>
+ <nextstate>FINISH</nextstate>
+ </skip>
+ <message nextstate="FINISH">A possibly skipped state</message>
+ </state>
+
+=cut
+
+no strict;
+@ISA = ("Apache::lonhelper::element");
+use strict;
+
+BEGIN {
+ &Apache::lonhelper::register('Apache::lonhelper::skip',
+ ('skip'));
+}
+
+sub new {
+ my $ref = Apache::lonhelper::element->new();
+ bless($ref);
+}
+
+sub start_skip {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ # let <cluase> know what text to skip to
+ $paramHash->{SKIPTAG}='/skip';
+ return '';
+}
+
+sub end_skip {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
+ if ($target ne 'helper') {
+ return '';
+ }
+ Apache::lonhelper::skip->new();
+ return '';
+}
+
+sub render {
+ my $self = shift;
+ return '';
+}
+# If a NEXTSTATE is set, switch to it
+sub preprocess {
+ my ($self) = @_;
+
+ if (defined($self->{NEXTSTATE})) {
+ $helper->changeState($self->{NEXTSTATE});
+ }
+
+ return 1;
+}
+
+1;
+
package Apache::lonhelper::choices;
=pod
@@ -1203,7 +1406,7 @@ sub render {
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
+ if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
@@ -1276,14 +1479,14 @@ BUTTONS
foreach my $choice (@{$self->{CHOICES}}) {
my $id = &new_id();
$result .= "<tr>\n<td width='20'> </td>\n";
- $result .= "<td valign='top'><input type='$type' name='$var.forminput'"
+ $result .= "<td valign='top'><input type='$type' name='${var}_forminput'"
. " value='" .
HTML::Entities::encode($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];
if ($choice->[3]) { # if we need to evaluate this choice
$choiceLabel = "sub { my $helper = shift; my $state = shift;" .
@@ -1291,11 +1494,11 @@ BUTTONS
$choiceLabel = eval($choiceLabel);
$choiceLabel = &$choiceLabel($helper, $self);
}
- $result .= "/></td><td> ".qq{<label for="id$id">}.
- $choiceLabel. "</label></td>";
+ $result .= " /></td><td> ".qq{<label for="id$id">}.
+ $choiceLabel. "</label></td>";
if ($choice->[4]) {
$result .='<td><input type="text" size="5" name="'
- .$choice->[4].'.forminput" value="'
+ .$choice->[4].'_forminput" value="'
.$choice->[5].'" /></td>';
}
$result .= "</tr>\n";
@@ -1310,7 +1513,8 @@ BUTTONS
# given, switch to it
sub postprocess {
my $self = shift;
- my $chosenValue = $env{'form.' . $self->{'variable'} . '.forminput'};
+ my $chosenValue = $env{'form.' . $self->{'variable'} . '_forminput'};
+
if (!defined($chosenValue) && !$self->{'allowempty'}) {
$self->{ERROR_MSG} =
@@ -1318,6 +1522,8 @@ sub postprocess {
return 0;
}
+
+
if (ref($chosenValue)) {
$helper->{VARS}->{$self->{'variable'}} = join('|||', @$chosenValue);
}
@@ -1334,7 +1540,7 @@ sub postprocess {
}
if ($choice->[4]) {
my $varname = $choice->[4];
- $helper->{'VARS'}->{$varname} = $env{'form.'."$varname.forminput"};
+ $helper->{'VARS'}->{$varname} = $env{'form.'."${varname}_forminput"};
}
}
return 1;
@@ -1443,7 +1649,7 @@ sub render {
$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
}
- $result .= "<select name='${var}.forminput'>\n";
+ $result .= "<select name='${var}_forminput'>\n";
foreach my $choice (@{$self->{CHOICES}}) {
$result .= "<option value='" .
HTML::Entities::encode($choice->[1],"<>&\"'")
@@ -1469,7 +1675,7 @@ sub render {
# given, switch to it
sub postprocess {
my $self = shift;
- my $chosenValue = $env{'form.' . $self->{'variable'} . '.forminput'};
+ my $chosenValue = $env{'form.' . $self->{'variable'} . '_forminput'};
if (!defined($chosenValue) && !$self->{'allowempty'}) {
$self->{ERROR_MSG} = "You must choose one or more choices to" .
@@ -1529,7 +1735,7 @@ no strict;
use strict;
use Apache::lonlocal; # A localization nightmare
use Apache::lonnet;
-use Time::localtime;
+use DateTime;
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::date',
@@ -1579,14 +1785,13 @@ sub render {
my $time=time;
my ($anytime,$onclick);
-
# first check VARS for a valid new value from the user
# then check DEFAULT_VALUE for a valid default time value
# otherwise pick now as reasonably good time
if (defined($helper->{VARS}{$var})
&& $helper->{VARS}{$var} > 0) {
- $date = localtime($helper->{VARS}{$var});
+ $date = &get_date_object($helper->{VARS}{$var});
} elsif (defined($self->{DEFAULT_VALUE})) {
my $valueFunc = eval($self->{DEFAULT_VALUE});
die('Error in default value code for variable ' .
@@ -1594,22 +1799,20 @@ sub render {
$time = &$valueFunc($helper, $self);
if (lc($time) eq 'anytime') {
$anytime=1;
- $date = localtime(time);
- $date->min(0);
+ $date = &get_date_object(time);
+ $date->set_minute(0);
} elsif (defined($time) && $time ne 0) {
- $date = localtime($time);
+ $date = &get_date_object($time);
} else {
# leave date undefined so it'll default to now
}
}
if (!defined($date)) {
- $date = localtime(time);
- $date->min(0);
+ $date = &get_date_object(time);
+ $date->set_minute(0);
}
- &Apache::lonnet::logthis("date mode ");
-
if ($anytime) {
$onclick = "onclick=\"javascript:updateCheck(this.form,'${var}anytime',false)\"";
}
@@ -1623,12 +1826,12 @@ sub render {
my $i;
$result .= "<select $onclick name='${var}month'>\n";
for ($i = 0; $i < 12; $i++) {
- if ($i == $date->mon) {
+ if (($i + 1) == $date->mon) {
$result .= "<option value='$i' selected='selected'>";
} else {
$result .= "<option value='$i'>";
}
- $result .= &mt($months[$i]) . "</option>\n";
+ $result .= &mt($months[$i])."</option>\n";
}
$result .= "</select>\n";
@@ -1647,7 +1850,7 @@ sub render {
# Year
$result .= "<select $onclick name='${var}year'>\n";
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'>";
} else {
$result .= "<option>";
@@ -1702,6 +1905,7 @@ sub render {
}
$result .= "</select>\n";
}
+ $result .= ' '.$date->time_zone_short_name().' ';
if ($self->{'anytime'}) {
$result.=(<<CHECK);
<script type="text/javascript">
@@ -1717,7 +1921,13 @@ CHECK
if ($anytime) {
$result.=' checked="checked" '
}
- $result.="name='${var}anytime'/>".&mt('Any time').'</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;
@@ -1729,7 +1939,8 @@ sub postprocess {
if ($env{'form.' . $var . 'anytime'}) {
$helper->{VARS}->{$var} = undef;
} else {
- my $month = $env{'form.' . $var . 'month'};
+ my $month = $env{'form.' . $var . 'month'};
+ $month ++;
my $day = $env{'form.' . $var . 'day'};
my $year = $env{'form.' . $var . 'year'};
my $min = 0;
@@ -1739,25 +1950,40 @@ sub postprocess {
$hour = $env{'form.' . $var . 'hour'};
}
- my $chosenDate;
- eval {$chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);};
+ my ($chosenDate,$checkDate);
+ my $timezone = &Apache::lonlocal::gettimezone();
+ my $dt;
+ eval {
+ $dt = DateTime->new( year => $year,
+ month => $month,
+ day => $day,
+ hour => $hour,
+ minute => $min,
+ second => 0,
+ time_zone => $timezone,
+ );
+ };
+
my $error = $@;
+ if (!$error) {
+ $chosenDate = $dt->epoch;
+ $checkDate = &get_date_object($chosenDate);
+ }
# Check to make sure that the date was not automatically co-erced into a
# valid date, as we want to flag that as an error
# This happens for "Feb. 31", for instance, which is coerced to March 2 or
# 3, depending on if it's a leap year
- my $checkDate = localtime($chosenDate);
if ($error || $checkDate->mon != $month || $checkDate->mday != $day ||
- $checkDate->year + 1900 != $year) {
+ $checkDate->year != $year) {
unless (Apache::lonlocal::current_language()== ~/^en/) {
$self->{ERROR_MSG} = &mt("Invalid date entry");
return 0;
}
# LOCALIZATION FIXME: Needs to be parameterized
- $self->{ERROR_MSG} = "Can't use " . $months[$month] . " $day, $year as a "
- . "date because it doesn't exist. Please enter a valid date.";
+ $self->{ERROR_MSG} = "Can't use ".$months[$env{'form.'.$var.'month'}]. " $day, $year as a ".
+ "date because it doesn't exist. Please enter a valid date.";
return 0;
}
@@ -1780,6 +2006,20 @@ sub postprocess {
return 1;
}
+
+sub get_date_object {
+ my ($epoch) = @_;
+ my $dt = DateTime->from_epoch(epoch => $epoch)
+ ->set_time_zone(&Apache::lonlocal::gettimezone());
+ my $lang = Apache::lonlocal::current_language();
+ if ($lang ne '') {
+ eval {
+ $dt->set_locale($lang);
+ };
+ }
+ return $dt;
+}
+
1;
package Apache::lonhelper::resource;
@@ -1806,7 +2046,10 @@ folders that have all of their contained
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.
+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
@@ -1839,6 +2082,49 @@ than 1 part.
evaluated with "sub { my $helper = shift; my $state = shift;" and
"}", 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
=cut
@@ -1875,10 +2161,14 @@ sub start_resource {
$paramHash->{'toponly'} = $token->[2]{'toponly'};
$paramHash->{'addstatus'} = $token->[2]{'addstatus'};
$paramHash->{'addparts'} = $token->[2]{'addparts'};
+ $paramHash->{'modalLink'} = $token->[2]{'modallink'};
+ $paramHash->{'nocurrloc'} = $token->[2]{'nocurrloc'};
+ $paramHash->{'suppressNavmap'} = $token->[2]{'suppressNavmap'};
if ($paramHash->{'addparts'}) {
$helper->declareVar($paramHash->{'variable'}.'_part');
}
$paramHash->{'closeallpages'} = $token->[2]{'closeallpages'};
+ $paramHash->{'include_top_level_map'} = $token->[2]{'includecourse'};
return '';
}
@@ -1967,20 +2257,42 @@ sub start_option {
if (!defined($paramHash->{OPTION_TEXTS})) {
$paramHash->{OPTION_TEXTS} = [ ];
$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
# values used to create column headings.
# OPTION_VARS is a list of the variable names, used to create the checkbox
# inputs.
+ # OPTION_TYPES is a list of the option types:
+ #
# 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};
+ my $option_types = $paramHash->{OPTION_TYPES};
push(@$option_texts, $token->[2]{'text'});
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
# persistent.
@@ -2024,7 +2336,7 @@ sub render {
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
+ if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
@@ -2056,7 +2368,9 @@ BUTTONS
my $multichoice = $self->{'multichoice'};
my $option_vars = $self->{OPTION_VARS};
my $option_texts = $self->{OPTION_TEXTS};
+ my $option_types = $self->{OPTION_TYPES};
my $addparts = $self->{'addparts'};
+ my $modalLink = $self->{'modalLink'};
my $headings_done = 0;
# Evaluate the map url as needed
@@ -2096,7 +2410,7 @@ BUTTONS
$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.
$headings_done = 1;
}
@@ -2114,21 +2428,56 @@ BUTTONS
my $resource_name =
HTML::Entities::encode($raw_name,"<>&\"'");
if($option_vars) {
+ my $option_num = 0;
foreach my $option_var (@$option_vars) {
+ my $option_type = $option_types->[$option_num];
+ $option_num++;
my $var_value = "\|\|\|" . $helper->{VARS}->{$option_var} .
"\|\|\|";
my $checked ="";
if($var_value =~ /\Q|||$raw_name|||\E/) {
$checked = "checked='checked'";
}
- $col .=
- "<td align='center'><input type='checkbox' name ='$option_var".
- ".forminput' value='".
- $resource_name . "' $checked /> </td>";
+ if ($option_type eq 'text') {
+ #
+ # For text's the variable value is a ||| separated set of
+ # 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) {
my $symb=$resource->symb();
if (exists($defaultSymbs{$symb})) {
@@ -2157,10 +2506,10 @@ BUTTONS
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";
+ $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\">".&Apache::lonlocal::mt('All Parts')."</option>\n";
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>";
}
@@ -2179,14 +2528,14 @@ BUTTONS
}
}
function updateHidden(form,id,name) {
- var select=form['part_'+id+'.forminput'];
- var hidden=form[name+'_part.forminput'];
+ 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" />
+<input type="hidden" name="${var}_part_forminput" />
RADIO
$env{'form.condition'} = !$self->{'toponly'};
@@ -2197,6 +2546,10 @@ RADIO
push @$cols, (Apache::lonnavmaps::part_status_summary());
}
+ my $caller;
+ if ($helper->{TITLE} eq 'Printing Helper') {
+ $caller = 'printout';
+ }
$result .=
&Apache::lonnavmaps::render( { 'cols' => $cols,
'showParts' => 0,
@@ -2204,7 +2557,13 @@ RADIO
'resource_no_folder_link' => 1,
'closeAllPages' => $self->{'closeallpages'},
'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;
@@ -2219,6 +2578,21 @@ sub postprocess {
$self->{ERROR_MSG} = 'You must choose at least one resource to continue.';
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})) {
$helper->changeState($self->{NEXTSTATE});
@@ -2261,6 +2635,12 @@ selection. Defaults to false.
If true, only active students and course personnel will be
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>:
If true, the selection of no users is allowed. Defaults to false.
@@ -2275,243 +2655,6 @@ use strict;
use Apache::lonlocal;
use Apache::lonnet;
-#
-# Utility function used when rendering the <student> tag.
-# This function renders a segment of course personel
-# Personel are broken up by the helper into past, current and
-# future...each one gets is own subpage of selection.
-# This sub renders one of these pages.
-# Parameters:
-# $students - Students in the section. (ref to array of references
-# to arrays).
-# $formprefix - form path prefix for form element names
-# This is used to make each form element
-# so that the segments having to do with each
-# set of students won't collide.
-# $defaultusers - reference to a hash containng
-# the set of users that should be on or off.
-# $multiselect - True if multiselect allowed.
-# $resultname - Name of result variable.
-# $javascript - If true, the javascript to run this is output
-# This should be true for the first call for a page
-# and false for all other calls... only matters if
-# multiselect is true.
-# Returns:
-# HTML text to add to the rendering of the helper.
-#
-sub render_student_list {
- my ($students, $formprefix, $defaultusers,
- $multiselect, $resultname, $javascript) = @_;
-
- my $result = "";
-
- if ($javascript && $multiselect) {
- $result .= <<SCRIPT;
-<script type="text/javascript">
-// <!--
-
- function findElement(name) {
- var i;
- var ele;
- for(i =0; i < document.forms.helpform.elements.length; i++) {
- ele = document.forms.helpform.elements[i];
- if(ele.name == name) {
- return ele;
- }
- }
- return null;
- }
- function isStudent(element) {
- if(element.value.indexOf(":Student") != -1) {
- return 1;
- }
- return 0;
- }
- function section(element) {
- var i;
- var info;
- if (element.value.indexOf(':') != -1) {
- info = element.value.split(':');
- return info[2];
- } else {
- return "";
- }
- }
- function rightSubForm(element, which) {
- if (element.value.indexOf(which) != -1) {
- return true;
- } else {
- return false;
- }
- }
-
- function setAllStudents(value, which) {
- var i;
- var ele;
- for (i =0; i < document.forms.helpform.elements.length; i++) {
- ele = document.forms.helpform.elements[i];
- if(isStudent(ele) && rightSubForm(ele, which)) {
- ele.checked=value;
- }
- }
- }
- function setAllCoursePersonnel(value, which) {
- var i;
- var ele;
- for (i =0; i < document.forms.helpform.elements.length; i++) {
- ele = document.forms.helpform.elements[i];
- if(!isStudent(ele) && rightSubForm(ele, which)) {
- ele.checked = value;
- }
- }
- }
- function setSection(which, value, subform) {
- var i;
- var ele;
- for (i =0; i < document.forms.helpform.elements.length; i++) {
- ele = document.forms.helpform.elements[i];
- if (ele.value.indexOf(':') != -1) {
- if ((section(ele) == which) && rightSubForm(ele, subform)) {
- ele.checked = value;
- }
- }
- }
- }
-
- function setCheckboxes(listbox, which, value) {
- var k;
- var elem;
- var what;
- elem = findElement(listbox);
- if (elem != null) {
- for (k = 0; k < elem.length; k++) {
- if (elem.options[k].selected) {
- what = elem.options[k].text;
- if (what == 'All Students') {
- setAllStudents(value, which);
- } else if (what == 'All Course Personnel') {
- setAllCoursePersonnel(value, which);
- } else if (what == 'No Section') {
- setSection('',value, which);
- } else {
- setSection(what, value, which);
- }
- }
- }
- }
- }
- function selectSections(listbox, which) {
- setCheckboxes(listbox, which, true);
-
- }
- function unselectSections(listbox, which) {
- setCheckboxes(listbox, which, false);
- }
-
-// -->
-</script>
-SCRIPT
-
- }
-
- # If multiple selections are allowed, we have a listbox
- # at the top which allows quick selections from each section
- # as well as from categories of personnel.
-
- if ($multiselect) {
- # Make a section hash so we can add sections to the choice:
-
- my %sections;
- for my $student (@$students) {
- my $sect = $student->[2];
- if ($sect ne "") {
- $sections{$sect} = 1;
- }
- }
-
- $result .= '<table><tr><td>';
-
- my $size = scalar(keys(%sections));
- $size += 3; # We have allstudents allpersonel nosection too.
- if ($size > 5) {
- $size = 5;
- }
- $result .= '<select multiple name="'.$formprefix
- .'.chosensections" size="'.$size.'">'."\n";
- $result .= '<option name="allstudents">All Students</option>';
- $result .= '<option name="allpersonnel">All Course Personnel</option>';
- $result .= '<option name="nosection">No Section</option>';
- $result .= "\n";
- foreach my $sec (sort {lc($a) cmp lc($b)} (keys(%sections))) {
- $result .= '<option name="'.$sec.'">'.$sec.'</option>'."\n";
- }
- $result .= '</td><td valign="top">';
- $result .= '<input type="button" name="'.$formprefix.'.select" value="Select" onclick='
- ."'selectSections(\"$formprefix.chosensections\", \"$formprefix\")'".' /></td>';
- $result .= '<td valign="top"><input type="button" name="'.$formprefix
- .'.unselect" value="Unselect" onclick='.
- "'unselectSections(\"$formprefix.chosensections\", \"$formprefix\")' ".' /></td></tr></table>';
- }
-
- # Now we list the students, but the form element type
- # will depend on whether or not multiselect is true.
- # True -> checkboxes.
- # False -> radiobuttons.
-
- $result .= "<table border=\"2\">\n";
- $result .= '<tr><th></th><th align="center">Name</th>'."\n";
- $result .= ' <th align="center">Section</th>'."\n";
- $result .= ' <th align="center">Status</th>'."\n";
- $result .= ' <th align="center">Role</th>'."\n";
- $result .= ' <th align="center">Username : Domain</th></tr>'."\n";
-
- my $input_type;
- if ($multiselect) {
- $input_type = "checkbox";
- } else {
- $input_type = "radio";
- }
-
- my $checked = 0;
- for my $student (@$students) {
- $result .= '<tr><td><input type="'.$input_type.'" name="'.
- $resultname.".forminput".'"';
- my $user = $student->[0];
-
- # Figure out which students are checked by default...
-
- if(%$defaultusers) {
- if (exists ($defaultusers->{$user})) {
- $result .= ' checked ="checked" ';
- $checked = 1;
- }
- } elsif (!$multiselect && !$checked) {
- $result .= ' checked="checked" ';
- $checked = 1; # First one for radio if no default specified.
- }
- $result .= ' value="'. HTML::Entities::encode($user . ':'
- .$student->[2] . ':'
- .$student->[1] . ':'
- .$student->[3] . ':'
- .$student->[4] . ":"
- .$formprefix, "<>&\"'")
- ."\" /></td><td>\n";
- $result .= HTML::Entities::encode($student->[1], '<>&"')
- . '</td><td align="center" >'."\n";
- $result .= HTML::Entities::encode($student->[2], '<>&"')
- . '</td><td align="center">'."\n";
- $result .= HTML::Entities::encode($student->[3], '<>&"')
- . '</td><td align="center">'."\n";
- $result .= HTML::Entities::encode($student->[4], '<>&"')
- . '</td><td align="center">'."\n";
- $result .= HTML::Entities::encode($student->[0], '<>&"')
- . '</td></tr>'."\n";
- }
- $result .=" </table> <br /> <hr />\n";
-
- return $result;
-}
-
BEGIN {
&Apache::lonhelper::register('Apache::lonhelper::student',
('student'));
@@ -2533,6 +2676,7 @@ sub start_student {
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
$paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
+ $paramHash->{'sectiononly'} = $token->[2]{'sectiononly'};
$paramHash->{'activeonly'} = $token->[2]{'activeonly'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
@@ -2574,122 +2718,82 @@ sub render {
delete($defaultUsers{''});
}
+ my $personnel_section;
+ if ($self->{'sectiononly'}) {
+ $personnel_section = $env{'request.course.sec'};
+ }
-
- # my $choices = [];
-
- #
- # We need to parcel out the personel in to three arrays:
- # $current_members[] - Contains those whose roles are currently active.
- # $expired_members[] - Contains those whose roles have expired.
- # $future_members[] - Contains those whose roles will become active in the
- # future.
- #
- # Constants
- my $section = &Apache::loncoursedata::CL_SECTION();
- my $fullname = &Apache::loncoursedata::CL_FULLNAME();
- my $status = &Apache::loncoursedata::CL_STATUS();
- my $start_date = &Apache::loncoursedata::CL_START();
-
- my $current_members = [];
- my $expired_members = [];
- my $future_members = [];
-
+ my ($course_personnel,
+ $current_members,
+ $expired_members,
+ $future_members) =
+ &Apache::lonselstudent::get_people_in_class($env{'request.course.sec'},
+ $personnel_section);
# 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 @$current_members, [join(':', @$person), $person->[0], '', $_];
- }
- }
- }
+ unshift @$current_members, (@$course_personnel);
}
-
- # Load up the students
- my $classlist = &Apache::loncoursedata::get_classlist();
- my @keys = keys %{$classlist};
- # Sort by: Section, name
- @keys = sort {
- if ($classlist->{$a}->[$section] ne $classlist->{$b}->[$section]) {
- return $classlist->{$a}->[$section] cmp $classlist->{$b}->[$section];
+ my %titles = &Apache::lonlocal::texthash(
+ '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'});
}
- return $classlist->{$a}->[$fullname] cmp $classlist->{$b}->[$fullname];
- } @keys;
-
-
-
-
- for (@keys) {
-
- if ( $classlist->{$_}->[$status] eq
- 'Active') {
- push @$current_members, [$_, $classlist->{$_}->[$fullname],
- $classlist->{$_}->[$section],
- $classlist->{$_}->[$status], 'Student'];
- } else {
- # Need to figure out if this user is future or
- # Expired... If the start date is in the future
- # the user is future...else expired.
-
- my $now = time;
- if ($classlist->{$_}->[$start_date] > $now) {
- push @$future_members, [$_, $classlist->{$_}->[$fullname],
- $classlist->{$_}->[$section],
- "Future", "Student"];
- } else {
- push @$expired_members, [$_, $classlist->{$_}->[$fullname],
- $classlist->{$_}->[$section],
- "Expired", "Student"];
- }
-
- }
- }
-
-
-
- # Current personel
-
- $result .= &render_student_list( $current_members,
- "current",
- \%defaultUsers,
- $self->{'multichoice'},
- $self->{'variable'},
- 1);
-
+ $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:
#
- if (!$self->{'activeonly'} && ((scalar @$expired_members) > 0)) {
+ if (!$self->{'activeonly'} && ((scalar(@$future_members)) > 0)) {
# And future.
- $result .= &render_student_list( $future_members,
- "future",
- \%defaultUsers,
- $self->{'multichoice'},
- $self->{'variable'},
- 0);
+ $result .= '<h4>'.$titles{'future'}.'</h4>';
+
+ $result .= &Apache::lonselstudent::render_student_list( $future_members,
+ "helpform",
+ "future",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 0);
+ }
+ if (!$self->{'activeonly'} && ((scalar(@$expired_members)) > 0)) {
# Past
- $result .= &render_student_list($expired_members,
- "past",
- \%defaultUsers,
- $self->{'multichoice'},
- $self->{'variable'},
- 0);
+ $result .= '<h4>'.$titles{'expired'}.'</h4>';
+ $result .= &Apache::lonselstudent::render_student_list($expired_members,
+ "helpform",
+ "past",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 0);
}
@@ -2700,7 +2804,7 @@ sub render {
sub postprocess {
my $self = shift;
- my $result = $env{'form.' . $self->{'variable'} . '.forminput'};
+ my $result = $env{'form.' . $self->{'variable'} . '_forminput'};
if (!$result && !$self->{'emptyallowed'}) {
if ($self->{'coursepersonnel'}) {
$self->{ERROR_MSG} =
@@ -2885,7 +2989,7 @@ sub render {
function checkall(value, checkName) {
for (i=0; i<document.forms.helpform.elements.length; i++) {
ele = document.forms.helpform.elements[i];
- if (ele.name == checkName + '.forminput') {
+ if (ele.name == checkName + '_forminput') {
document.forms.helpform.elements[i].checked=value;
}
}
@@ -2924,30 +3028,31 @@ BUTTONS
}
# Get the list of files in this directory.
- my @fileList;
+ my (@fileList,$listref,$listerror);
# If the subdirectory is in local CSTR space
my $metadir;
- if ($subdir =~ m|/home/([^/]+)/public_html/(.*)|) {
- my ($user,$domain)=
- &Apache::loncacc::constructaccess($subdir,
- $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 $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
+ if ($subdir =~ m{^(?:\Q$londocroot\E)*/priv/[^/]+/[^/]+/(.*)$}) {
+ my $innerpath=$1;
+ unless ($subdir=~m{^\Q$londocroot\E}) {
+ $subdir=$londocroot.$subdir;
+ }
my ($user,$domain)=
- &Apache::loncacc::constructaccess($subdir,
- $Apache::lonnet::perlvar{'lonDefDomain'});
- $metadir='/res/'.$domain.'/'.$user.'/'.$2;
- @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
+ &Apache::lonnet::constructaccess($subdir);
+ $metadir='/res/'.$domain.'/'.$user.'/'.$innerpath;
+ ($listref,$listerror) =
+ &Apache::lonnet::dirlist($subdir,$domain,$user,undef,undef,'/');
} else {
# local library server resource space
- @fileList = &Apache::lonnet::dirlist($subdir, $env{'user.domain'}, $env{'user.name'}, '');
+ ($listref,$listerror) =
+ &Apache::lonnet::dirlist($subdir,$env{'user.domain'},$env{'user.name'},undef,undef,'/');
}
# 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;
@@ -3002,7 +3107,7 @@ BUTTONS
my $id = &new_id();
$result .= '<tr><td align="right"' . " bgcolor='$color'>" .
"<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) {
$result .= ' checked="checked"';
@@ -3042,7 +3147,7 @@ sub fileState {
}
my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
my $subdirpart = $constructionSpaceDir;
- $subdirpart =~ s/^\/home\/$uname\/public_html//;
+ $subdirpart =~ s{^\Q$docroot/priv/$udom/$uname\E}{};
my $resdir = $docroot . '/res/' . $udom . '/' . $uname .
$subdirpart;
@@ -3063,7 +3168,7 @@ sub fileState {
sub postprocess {
my $self = shift;
- my $result = $env{'form.' . $self->{'variable'} . '.forminput'};
+ my $result = $env{'form.' . $self->{'variable'} . '_forminput'};
if (!$result) {
$self->{ERROR_MSG} = 'You must choose at least one file '.
'to continue.';
@@ -3092,7 +3197,7 @@ It takes the standard attributes "variab
"allowempty" and "nextstate", meaning what they do for most other
elements.
-also takes a boolean 'onlysections' whcih will restrict this to only
+also takes a boolean 'onlysections' which will restrict this to only
have sections and not include groups
=cut
@@ -3130,22 +3235,27 @@ sub start_section {
# Populate the CHOICES element
my %choices;
+ my $usersec = $Apache::lonnet::env{'request.course.sec'};
- my $section = Apache::loncoursedata::CL_SECTION();
- my $classlist = Apache::loncoursedata::get_classlist();
- foreach my $user (keys(%$classlist)) {
- my $section_name = $classlist->{$user}[$section];
- if (!$section_name) {
- $choices{"No section assigned"} = "";
- } else {
- $choices{$section_name} = $section_name;
+ if ($usersec ne '') {
+ $choices{$usersec} = $usersec;
+ } else {
+ my $section = Apache::loncoursedata::CL_SECTION();
+ my $classlist = Apache::loncoursedata::get_classlist();
+ foreach my $user (keys(%$classlist)) {
+ my $section_name = $classlist->{$user}[$section];
+ if (!$section_name) {
+ $choices{"No section assigned"} = "";
+ } else {
+ $choices{$section_name} = $section_name;
+ }
+ }
+
+ if (exists($choices{"No section assigned"})) {
+ push(@{$paramHash->{CHOICES}},
+ ['No section assigned','No section assigned']);
+ delete($choices{"No section assigned"});
}
- }
-
- if (exists($choices{"No section assigned"})) {
- push(@{$paramHash->{CHOICES}},
- ['No section assigned','No section assigned']);
- delete($choices{"No section assigned"});
}
for my $section_name (sort {lc($a) cmp lc($b) } (keys(%choices))) {
push @{$paramHash->{CHOICES}}, [$section_name, $section_name];
@@ -3153,7 +3263,7 @@ sub start_section {
return if ($token->[2]{'onlysections'});
# add in groups to the end of the list
- my %curr_groups = &Apache::loncommon::coursegroups();
+ my %curr_groups = &Apache::longroup::coursegroups();
foreach my $group_name (sort(keys(%curr_groups))) {
push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}
@@ -3181,6 +3291,10 @@ It takes the standard attributes "variab
"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.
+
=cut
no strict;
@@ -3210,6 +3324,7 @@ sub start_group {
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
$paramHash->{'allowempty'} = $token->[2]{'allowempty'};
+ $paramHash->{'grouponly'} = $token->[2]{'grouponly'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
@@ -3217,7 +3332,12 @@ sub start_group {
# Populate the CHOICES element
my %choices;
- my %curr_groups = &Apache::loncommon::coursegroups();
+ my %curr_groups;
+ if ((!$paramHash->{'grouponly'}) || (&Apache::lonnet::allowed('mdg',$Apache::lonnet::env{'request.course.id'}))) {
+ %curr_groups = &Apache::longroup::coursegroups();
+ } elsif ($Apache::lonnet::env{'request.course.groups'} ne '') {
+ map { $curr_groups{$_} = 1; } split(/:/,$Apache::lonnet::env{'request.course.groups'});
+ }
foreach my $group_name (sort {lc($a) cmp lc($b)} (keys(%curr_groups))) {
push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}
@@ -3242,6 +3362,10 @@ package Apache::lonhelper::string;
string elements provide a string entry field for the user. string elements
take the usual 'variable' and 'nextstate' parameters. string elements
also pass through 'maxlength' and 'size' attributes to the input tag.
+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.
@@ -3261,6 +3385,7 @@ BEGIN {
sub new {
my $ref = Apache::lonhelper::element->new();
+ $ref->{'PROCEED'} = 1; # By default postprocess goes to next state.
bless($ref);
}
@@ -3277,20 +3402,33 @@ sub start_string {
$paramHash->{'nextstate'} = $token->[2]{'nextstate'};
$paramHash->{'maxlength'} = $token->[2]{'maxlength'};
$paramHash->{'size'} = $token->[2]{'size'};
-
return '';
}
sub end_string {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+
if ($target ne 'helper') {
return '';
}
- Apache::lonhelper::string->new();
+ my $state = Apache::lonhelper::string->new();
+
+
+ if(&Apache::lonxml::get_param('noproceed', $parstack, $safeeval, undef, 1)) {
+ $state->noproceed();
+ }
+
+
+
return '';
}
+sub noproceed() {
+ my $self = shift;
+ $self->{PROCEED} = 0;
+}
+
sub render {
my $self = shift;
my $result = '';
@@ -3299,7 +3437,7 @@ sub render {
$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'})) {
$result .= ' size="' . $self->{'size'} . '"';
@@ -3334,7 +3472,7 @@ sub postprocess {
}
}
- if (defined($self->{'nextstate'})) {
+ if (defined($self->{'nextstate'}) && $self->{PROCEED}) {
$helper->changeState($self->{'nextstate'});
}
@@ -3432,7 +3570,8 @@ sub start_clause {
die 'Error in clause of condition, Perl said: ' . $@ if $@;
if (!&$clause($helper, $paramHash)) {
# Discard all text until the /condition.
- &Apache::lonxml::get_all_text('/condition', $parser);
+ my $end_tag = $paramHash->{SKIPTAG} || '/condition';
+ &Apache::lonxml::get_all_text($end_tag, $parser);
}
}
@@ -3491,7 +3630,7 @@ snippets and collecting the results. Fin
helper, going to a provided page.
If the parameter "restartCourse" is true, this will override the buttons and
-will make a "Finish Helper" button that will re-initialize the course for them,
+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
the old values taking effect.
@@ -3560,7 +3699,7 @@ sub render {
my @results;
# Collect all the results
- for my $stateName (keys %{$helper->{STATES}}) {
+ for my $stateName (keys(%{$helper->{STATES}})) {
my $state = $helper->{STATES}->{$stateName};
for my $element (@{$state->{ELEMENTS}}) {
@@ -3598,7 +3737,7 @@ sub render {
my $actionURL = $self->{EXIT_PAGE};
my $targetURL = '';
- my $finish=&mt('Finish');
+ my $finish=&mt('Save');
if ($self->{'restartCourse'}) {
$actionURL = '/adm/roles';
$targetURL = '/adm/menu';
@@ -3610,21 +3749,17 @@ sub render {
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 ->"), '<>&"');
- my $target = " target='loncapaclient'";
- if (($env{'browser.interface'} eq 'textual') ||
- ($env{'environment.remote'} eq 'off')) { $target=''; }
- $result .= "<center>\n" .
- "<form action='".$actionURL."' method='post' $target>\n" .
+ my $previous = HTML::Entities::encode(&mt("Back"), '<>&"');
+ my $next = HTML::Entities::encode(&mt("Next"), '<>&"');
+ $result .= "<p>\n" .
+ "<form action='".$actionURL."' method='post' >\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>";
+ "</form></p>\n";
return $result;
}
@@ -3637,7 +3772,7 @@ sub overrideForm {
package Apache::lonhelper::parmwizfinal;
-# This is the final state for the parmwizard. It is not generally useful,
+# This is the final state for the parm helper. It is not generally useful,
# so it is not perldoc'ed. It does its own processing.
# It is represented with <parmwizfinal />, and
# should later be moved to lonparmset.pm .
@@ -3703,44 +3838,77 @@ sub render {
# Print the granularity, depending on the action
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') {
- $level = 11; # general course, see lonparmset.pm perldoc
+ $level = 18; # general course, see lonparmset.pm perldoc
} elsif ($vars->{TARGETS} eq 'section') {
- $level = 6;
+ $level = 12;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 8;
} else {
- $level = 3;
+ $level = 4;
}
$affectedResourceId = "0.0";
$symb = 'a';
$paramlevel = 'general';
- } elsif ($vars->{GRANULARITY} eq 'map') {
+ } elsif (($vars->{GRANULARITY} eq 'map') || ($vars->{GRANULARITY} eq 'maprecurse')) {
my $navmap = Apache::lonnavmaps::navmap->new();
- my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
- my $title = $res->compTitle();
- $symb = $res->symb();
- $resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
- if ($vars->{TARGETS} eq 'course') {
- $level = 10; # general course, see lonparmset.pm perldoc
- } elsif ($vars->{TARGETS} eq 'section') {
- $level = 5;
- } else {
- $level = 2;
- }
+ if (defined($navmap)) {
+ my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
+ my $title = $res->compTitle();
+ $symb = $res->symb();
+ if ($vars->{GRANULARITY} eq 'map') {
+ $resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
+ } else {
+ $resourceString .= '<li>'.&mt('for the map named [_1] (applies recursively to sub-folders)',"<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->{GRANULARITY} eq 'maprecurse') {
+ if ($vars->{TARGETS} eq 'course') {
+ $level = 17; # general course, see lonparmset.pm perldoc
+ } elsif ($vars->{TARGETS} eq 'section') {
+ $level = 11;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 7;
+ } else {
+ $level = 3;
+ }
+ } else {
+ if ($vars->{TARGETS} eq 'course') {
+ $level = 16; # general course, see lonparmset.pm perldoc
+ } elsif ($vars->{TARGETS} eq 'section') {
+ $level = 10;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 6;
+ } else {
+ $level = 2;
+ }
+ }
$affectedResourceId = $vars->{RESOURCE_ID};
$paramlevel = 'map';
} else {
- my $navmap = Apache::lonnavmaps::navmap->new();
- 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();
- my $title = $res->compTitle();
- $resourceString .= '<li>'.&mt('for the resource named [_1] part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ if (defined($navmap)) {
+ my $res = $navmap->getById($vars->{RESOURCE_ID});
+ $symb = $res->symb();
+ my $title = $res->compTitle();
+ $resourceString .= '<li>'.&mt('for the resource named [_1], part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
+ } else {
+ $resourceString .= '<li>'.&mt('for the resource ID [_1] (name unavailable), part [_2]','<b>'.$vars->{RESOURCE_ID}.'</b>',"<b>$part</b>").'</li>';
+ &Apache::lonnet::logthis('Retrieval of resource title failed in lonhelper.pm - could not create navmap object for course.');
+ }
if ($vars->{TARGETS} eq 'course') {
- $level = 7; # general course, see lonparmset.pm perldoc
+ $level = 13; # general course, see lonparmset.pm perldoc
} elsif ($vars->{TARGETS} eq 'section') {
- $level = 4;
+ $level = 9;
+ } elsif ($vars->{TARGETS} eq 'group') {
+ $level = 5;
} else {
$level = 1;
}
@@ -3748,7 +3916,7 @@ sub render {
$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='dis' value='helper' />\n";
$result .= "<input type='hidden' name='pscat' value='".
@@ -3756,7 +3924,7 @@ sub render {
if ($vars->{GRANULARITY} eq 'resource') {
$result .= "<input type='hidden' name='symb' value='".
HTML::Entities::encode($symb,"'<>&\"") . "' />\n";
- } elsif ($vars->{GRANULARITY} eq 'map') {
+ } elsif (($vars->{GRANULARITY} eq 'map') || ($vars->{GRANULARITY} eq 'maprecurse')) {
$result .= "<input type='hidden' name='pschp' value='".
$affectedResourceId."' />\n";
}
@@ -3765,7 +3933,10 @@ sub render {
$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>';
+ $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:
my $extra;
@@ -3813,7 +3984,7 @@ sub render {
# Print targets
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') {
my $section = $vars->{SECTION_NAME};
$result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';
@@ -3838,9 +4009,21 @@ sub render {
# Print value
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
$result .= "\n<input type='hidden' name='pres_marker'" .
" value='$affectedResourceId&$parm_name&$level' />\n";
@@ -3850,7 +4033,7 @@ sub render {
$result .= "\n<input type='hidden' value='$symb' name='pssymb' />";
$result .= "\n<input type='hidden' value='$paramlevel' name='parmlev' />";
- $result .= "<br /><br /><center><input type='submit' value='".&mt('Finish Helper')."' /></center></form>\n";
+ $result .= $buttons;
return $result;
}