--- loncom/interface/lonhelper.pm 2005/11/22 12:49:50 1.128
+++ loncom/interface/lonhelper.pm 2006/05/15 22:01:12 1.149
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# .helper XML handler to implement the LON-CAPA helper
#
-# $Id: lonhelper.pm,v 1.128 2005/11/22 12:49:50 raeburn Exp $
+# $Id: lonhelper.pm,v 1.149 2006/05/15 22:01:12 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -183,6 +183,7 @@ use Apache::File;
use Apache::lonxml;
use Apache::lonlocal;
use Apache::lonnet;
+use Apache::lonselstudent;
# Register all the tags with the helper, so the helper can
# push and pop them
@@ -573,22 +574,20 @@ sub display {
}
# Phase 4: Display.
- my $html=&Apache::lonxml::xmlbegin();
my $stateTitle=&mt($state->title());
- my $helperTitle = &mt($self->{TITLE});
- my $bodytag = &Apache::loncommon::bodytag($helperTitle,'','');
+ 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
- my $loncapaHelper = &mt("LON-CAPA Helper:");
- $result .= <<HEADER;
-$html
- <head>
- <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>
@@ -651,10 +650,9 @@ HEADER
</tr>
</table>
</form>
- </body>
-</html>
FOOTER
+ $result .= &Apache::loncommon::end_page();
# Handle writing out the vars to the file
my $file = Apache::File->new('>'.$self->{FILENAME});
print $file $self->_varsInFile();
@@ -1072,6 +1070,16 @@ will be the state transistioned to if th
the choice is not multichoice. This will override the nextstate
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
To create the choices programmatically, either wrap the choices in
@@ -1162,10 +1170,12 @@ sub start_choice {
my $computer = $token->[2]{'computer'};
my $human = &mt(&Apache::lonxml::get_all_text('/choice',
$parser));
- my $nextstate = $token->[2]{'nextstate'};
- my $evalFlag = $token->[2]{'eval'};
+ my $nextstate = $token->[2]{'nextstate'};
+ my $evalFlag = $token->[2]{'eval'};
+ my $relatedVar = $token->[2]{'relatedvalue'};
+ my $relatedDefault = $token->[2]{'relateddefault'};
push @{$paramHash->{CHOICES}}, [&mtn($human), $computer, $nextstate,
- $evalFlag];
+ $evalFlag, $relatedVar, $relatedDefault];
return '';
}
@@ -1275,14 +1285,20 @@ BUTTONS
}
$result .= qq{id="id$id"};
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 . "}";
$choiceLabel = eval($choiceLabel);
$choiceLabel = &$choiceLabel($helper, $self);
}
$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 .= $buttons;
@@ -1316,6 +1332,10 @@ sub postprocess {
$helper->changeState($choice->[2]);
}
}
+ if ($choice->[4]) {
+ my $varname = $choice->[4];
+ $helper->{'VARS'}->{$varname} = $env{'form.'."$varname.forminput"};
+ }
}
return 1;
}
@@ -1559,19 +1579,41 @@ sub render {
my $time=time;
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 = localtime($helper->{VARS}{$var});
+ } elsif (defined($self->{DEFAULT_VALUE})) {
my $valueFunc = eval($self->{DEFAULT_VALUE});
die('Error in default value code for variable ' .
$self->{'variable'} . ', Perl said: ' . $@) if $@;
$time = &$valueFunc($helper, $self);
- if (lc($time) eq 'anytime') { $time=time; $anytime=1; }
+ if (lc($time) eq 'anytime') {
+ $anytime=1;
+ $date = localtime(time);
+ $date->min(0);
+ } elsif (defined($time) && $time ne 0) {
+ $date = localtime($time);
+ } else {
+ # leave date undefined so it'll default to now
+ }
}
+
+ if (!defined($date)) {
+ $date = localtime(time);
+ $date->min(0);
+ }
+
+ &Apache::lonnet::logthis("date mode ");
+
if ($anytime) {
$onclick = "onclick=\"javascript:updateCheck(this.form,'${var}anytime',false)\"";
}
# Default date: The current hour.
- $date = localtime($time);
- $date->min(0);
if (defined $self->{ERROR_MSG}) {
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
@@ -1675,7 +1717,7 @@ CHECK
if ($anytime) {
$result.=' checked="checked" '
}
- $result.="name='${var}anytime'/>".&mt('Anytime').'</label>'
+ $result.="name='${var}anytime'/>".&mt('Any time').'</label>'
}
return $result;
@@ -1722,6 +1764,16 @@ sub postprocess {
$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})) {
$helper->changeState($self->{NEXTSTATE});
}
@@ -2267,104 +2319,6 @@ sub render {
my $buttons = '';
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}) {
$result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
@@ -2382,145 +2336,59 @@ BUTTONS
%defaultUsers = map { if ($_) {($_,1) } } @defaultUsers;
delete($defaultUsers{''});
}
- my $choices = [];
+
+
+ my ($course_personnel,
+ $current_members,
+ $expired_members,
+ $future_members) = &Apache::lonselstudent::get_people_in_class();
+
+
# Load up the non-students, if necessary
+
if ($self->{'coursepersonnel'}) {
- my %coursepersonnel = Apache::lonnet::get_course_adv_roles();
- for (sort keys %coursepersonnel) {
- for my $role (split /,/, $coursepersonnel{$_}) {
- # extract the names so we can sort them
- my @people;
-
- for (split /,/, $role) {
- push @people, [split /:/, $role];
- }
-
- @people = sort { $a->[0] cmp $b->[0] } @people;
-
- for my $person (@people) {
- push @$choices, [join(':', @$person), $person->[0], '', $_];
- }
- }
- }
+ unshift @$current_members, (@$course_personnel);
}
- # Constants
- my $section = Apache::loncoursedata::CL_SECTION();
- my $fullname = Apache::loncoursedata::CL_FULLNAME();
- my $status = Apache::loncoursedata::CL_STATUS();
- # Load up the students
- my $classlist = &Apache::loncoursedata::get_classlist();
- my @keys = keys %{$classlist};
- # Sort by: Section, name
- @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'];
- }
- }
+ # Current personel
- my $name = $self->{'coursepersonnel'} ? &mt('Name') : &mt('Student Name');
- 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>";
+ $result .= &Apache::lonselstudent::render_student_list( $current_members,
+ "helpform",
+ "current",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 1);
- my $checked = 0;
- for my $choice (@$choices) {
- $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";
- $result .= $buttons;
+ # 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->{'multichoice'}) {
- my %sections;
- for my $key (@keys) {
- my $section_name = $classlist->{$key}->[$section];
- if ($section_name ne "") {
- $sections{$section_name} = 1;
- }
- }
- # The variable $choice_widget will have the html to make the choice
- # selector.
- my $size=5;
- if (scalar(keys(%sections)) < 5) {
- $size=scalar(keys(%sections));
- }
- my $choice_widget = '<select multiple name="chosensections" size="'.$size.'">'."\n";
- foreach my $sec (sort {lc($a) cmp lc($b)} (keys(%sections))) {
- $choice_widget .= "<option name=\"$sec\">$sec</option>\n";
- }
- $choice_widget .= "<option>none</option></select>\n";
+ if (!$self->{'activeonly'} && ((scalar @$expired_members) > 0)) {
- # Build a table without any borders to contain the section based
- # selection:
+ # And future.
- my $section_selectors =<<SECTIONSELECT;
-<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;
+ $result .= &Apache::lonselstudent::render_student_list( $future_members,
+ "helpform",
+ "future",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 0);
+ # Past
+
+ $result .= &Apache::lonselstudent::render_student_list($expired_members,
+ "helpform",
+ "past",
+ \%defaultUsers,
+ $self->{'multichoice'},
+ $self->{'variable'},
+ 0);
}
+
+
+
return $result;
}
@@ -2915,8 +2783,12 @@ package Apache::lonhelper::section;
<section> allows the user to choose one or more sections from the current
course.
-It takes the standard attributes "variable", "multichoice", and
-"nextstate", meaning what they do for most other elements.
+It takes the standard attributes "variable", "multichoice",
+"allowempty" and "nextstate", meaning what they do for most other
+elements.
+
+also takes a boolean 'onlysections' whcih will restrict this to only
+have sections and not include groups
=cut
@@ -2946,6 +2818,7 @@ sub start_section {
$paramHash->{'variable'} = $token->[2]{'variable'};
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
@@ -2955,18 +2828,29 @@ sub start_section {
my $section = Apache::loncoursedata::CL_SECTION();
my $classlist = Apache::loncoursedata::get_classlist();
- foreach (keys %$classlist) {
- my $sectionName = $classlist->{$_}->[$section];
- if (!$sectionName) {
+ foreach my $user (keys(%$classlist)) {
+ my $section_name = $classlist->{$user}[$section];
+ if (!$section_name) {
$choices{"No section assigned"} = "";
} else {
- $choices{$sectionName} = $sectionName;
+ $choices{$section_name} = $section_name;
}
}
- for my $sectionName (sort(keys(%choices))) {
-
- push @{$paramHash->{CHOICES}}, [$sectionName, $sectionName];
+ 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];
+ }
+ return if ($token->[2]{'onlysections'});
+
+ # add in groups to the end of the list
+ my %curr_groups = &Apache::loncommon::coursegroups();
+ foreach my $group_name (sort(keys(%curr_groups))) {
+ push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}
}
@@ -2986,10 +2870,12 @@ package Apache::lonhelper::group;
=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.
-It takes the standard attributes "variable", "multichoice", and "nextstate", meaning what they do for most other elements.
-
=cut
no strict;
@@ -3018,6 +2904,7 @@ sub start_group {
$paramHash->{'variable'} = $token->[2]{'variable'};
$helper->declareVar($paramHash->{'variable'});
$paramHash->{'multichoice'} = $token->[2]{'multichoice'};
+ $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
if (defined($token->[2]{'nextstate'})) {
$paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
}
@@ -3025,18 +2912,12 @@ sub start_group {
# Populate the CHOICES element
my %choices;
- my $numgroups;
- my %curr_groups;
- if (&Apache::loncommon::coursegroups(\%curr_groups)) {
- foreach my $group_name (keys %curr_groups) {
- $choices{$group_name} = $group_name;
- }
- }
- foreach my $group_name (sort(keys(%choices))) {
- push @{$paramHash->{CHOICES}}, [$group_name, $group_name];
+ my %curr_groups = &Apache::loncommon::coursegroups();
+ foreach my $group_name (sort {lc($a) cmp lc($b)} (keys(%curr_groups))) {
+ push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
}
}
-
+
sub end_group {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
@@ -3140,7 +3021,7 @@ sub postprocess {
if (defined($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());
if ($invalid) {
$self->{ERROR_MSG} = $invalid;