--- loncom/interface/lonhelper.pm 2003/08/13 14:49:58 1.42 +++ loncom/interface/lonhelper.pm 2006/04/24 23:20:37 1.138 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # .helper XML handler to implement the LON-CAPA helper # -# $Id: lonhelper.pm,v 1.42 2003/08/13 14:49:58 bowersj2 Exp $ +# $Id: lonhelper.pm,v 1.138 2006/04/24 23:20:37 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,16 +25,26 @@ # # http://www.lon-capa.org/ # -# (Page Handler -# -# (.helper handler -# =pod -=head1 lonhelper - HTML Helper framework for LON-CAPA +=head1 NAME + +lonhelper - implements helper framework + +=head1 SYNOPSIS + +lonhelper implements the helper framework for LON-CAPA, and provides + many generally useful components for that framework. -Helpers, often known as "wizards", are well-established UI widgets that users +Helpers are little programs which present the user with a sequence of + simple choices, instead of one monolithic multi-dimensional + choice. They are also referred to as "wizards", "druids", and + other potentially trademarked or semantically-loaded words. + +=head1 OVERVIEWX + +Helpers are well-established UI widgets that users feel comfortable with. It can take a complicated multidimensional problem the user has and turn it into a series of bite-sized one-dimensional questions. @@ -46,7 +56,7 @@ directory and having the .helper file ex All classes are in the Apache::lonhelper namespace. -=head2 lonhelper XML file format +=head1 lonhelper XML file formatX A helper consists of a top-level tag which contains a series of states. Each state contains one or more state elements, which are what the user sees, like @@ -87,7 +97,7 @@ Of course this does nothing. In order fo necessary to put actual elements into the wizard. Documentation for each of these elements follows. -=head2 Creating a Helper With Code, Not XML +=head1 Creating a Helper With Code, Not XML In some situations, such as the printing wizard (see lonprintout.pm), writing the helper in XML would be too complicated, because of scope @@ -146,10 +156,10 @@ Normally the machinery in the XML format adding states can easily be done by wrapping the state in a tag. This should only be used when the code dominates the XML content, the code is so complicated that it is difficult to get access to -all of the information you need because of scoping issues, or so much -of the information used is persistent because would-be or - blocks that using the {DATA} mechanism results in hard-to-read -and -maintain code. +all of the information you need because of scoping issues, or would-be or + blocks using the {DATA} mechanism results in hard-to-read +and -maintain code. (See course.initialization.helper for a borderline +case.) It is possible to do some of the work with an XML fragment parsed by lonxml; again, see lonprintout.pm for an example. In that case it is @@ -158,12 +168,21 @@ before parsing XML fragments and B # mod_perl connection. In this code, it was manifesting itself in the existence -# of two seperate file-scoped $helper variables, one set to the value of the +# of two separate file-scoped $helper variables, one set to the value of the # helper in the helper constructor, and one referenced by the handler on the -# "$helper->process()" line. The second was therefore never set, and was still +# "$helper->process()" line. Using the debugger, one could actually +# see the two different $helper variables, as hashes at completely +# different addresses. The second was therefore never set, and was still # undefined when I tried to call process on it. # By pushing the "real handler" down into the "real scope", everybody except the # actual handler function directly below this comment gets the same $helper and @@ -231,7 +252,7 @@ sub real_handler { my $r = shift; my $uri = shift; if (!defined($uri)) { $uri = $r->uri(); } - $ENV{'request.uri'} = $uri; + $env{'request.uri'} = $uri; my $filename = '/home/httpd/html' . $uri; my $fh = Apache::File->new($filename); my $file; @@ -239,21 +260,13 @@ sub real_handler { # Send header, don't cache this page - if ($r->header_only) { - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); - } else { - $r->content_type('text/html'); - } - $r->send_http_header; - return OK; - } - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); + if ($env{'browser.mathml'}) { + &Apache::loncommon::content_type($r,'text/xml'); } else { - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); } $r->send_http_header; + return OK if $r->header_only; $r->rflush(); # Discard result, we just want the objects that get created by the @@ -262,7 +275,7 @@ sub real_handler { my $allowed = $helper->allowedCheck(); if (!$allowed) { - $ENV{'user.error.msg'} = $ENV{'request.uri'}.':'.$helper->{REQUIRED_PRIV}. + $env{'user.error.msg'} = $env{'request.uri'}.':'.$helper->{REQUIRED_PRIV}. ":0:0:Permission denied to access this helper."; return HTTP_NOT_ACCEPTABLE; } @@ -343,9 +356,11 @@ sub end_state { package Apache::lonhelper::helper; use Digest::MD5 qw(md5_hex); -use HTML::Entities; +use HTML::Entities(); use Apache::loncommon; use Apache::File; +use Apache::lonlocal; +use Apache::lonnet; sub new { my $proto = shift; @@ -357,16 +372,16 @@ sub new { # If there is a state from the previous form, use that. If there is no # state, use the start state parameter. - if (defined $ENV{"form.CURRENT_STATE"}) + if (defined $env{"form.CURRENT_STATE"}) { - $self->{STATE} = $ENV{"form.CURRENT_STATE"}; + $self->{STATE} = $env{"form.CURRENT_STATE"}; } else { $self->{STATE} = "START"; } - $self->{TOKEN} = $ENV{'form.TOKEN'}; + $self->{TOKEN} = $env{'form.TOKEN'}; # If a token was passed, we load that in. Otherwise, we need to create a # new storage file # Tried to use standard Tie'd hashes, but you can't seem to take a @@ -399,16 +414,16 @@ sub new { return undef; } # Must create the storage - $self->{TOKEN} = md5_hex($ENV{'user.name'} . $ENV{'user.domain'} . + $self->{TOKEN} = md5_hex($env{'user.name'} . $env{'user.domain'} . time() . rand()); $self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN}); } # OK, we now have our persistent storage. - if (defined $ENV{"form.RETURN_PAGE"}) + if (defined $env{"form.RETURN_PAGE"}) { - $self->{RETURN_PAGE} = $ENV{"form.RETURN_PAGE"}; + $self->{RETURN_PAGE} = $env{"form.RETURN_PAGE"}; } else { @@ -437,11 +452,11 @@ sub _saveVars { my $self = shift; my $result = ""; $result .= '\n"; + HTML::Entities::encode($self->{STATE},'<>&"') . "\" />\n"; $result .= '\n"; $result .= '\n"; + HTML::Entities::encode($self->{RETURN_PAGE},'<>&"') . "\" />\n"; return $result; } @@ -469,11 +484,11 @@ sub declareVar { } my $envname = 'form.' . $var . '.forminput'; - if (defined($ENV{$envname})) { - if (ref($ENV{$envname})) { - $self->{VARS}->{$var} = join('|||', @{$ENV{$envname}}); + if (defined($env{$envname})) { + if (ref($env{$envname})) { + $self->{VARS}->{$var} = join('|||', @{$env{$envname}}); } else { - $self->{VARS}->{$var} = $ENV{$envname}; + $self->{VARS}->{$var} = $env{$envname}; } } } @@ -485,7 +500,7 @@ sub allowedCheck { return 1; } - return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $ENV{'request.course.id'}); + return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $env{'request.course.id'}); } sub changeState { @@ -507,7 +522,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 "Next ->") { + if ($self->{STATE} ne "START" || $env{"form.SUBMIT"} eq &mt("Next ->")) { my $prevState = $self->{STATES}{$self->{STATE}}; $prevState->postprocess(); } @@ -558,16 +573,20 @@ sub display { } # Phase 4: Display. - my $stateTitle = $state->title(); - my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'',''); + my $stateTitle=&mt($state->title()); + my $browser_searcher_js = + ''; + + $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 + - $result .= < - - LON-CAPA Helper: $self->{TITLE} - - $bodytag -HEADER if (!$state->overrideForm()) { $result.="
"; } $result .= < @@ -591,12 +610,12 @@ HEADER } if ($self->{DONE}) { my $returnPage = $self->{RETURN_PAGE}; - $result .= "End Helper"; + $result .= "" . &mt("End Helper") . ""; } else { $result .= ' '; + $result .= ''; } } @@ -610,12 +629,12 @@ HEADER } if ($self->{DONE}) { my $returnPage = $self->{RETURN_PAGE}; - $result .= "End Helper"; + $result .= "" . &mt('End Helper') . ""; } else { $result .= ' '; + $result .= ''; } } @@ -630,10 +649,9 @@ HEADER - - 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(); @@ -748,12 +766,12 @@ package Apache::lonhelper::element; =pod -=head2 Element Base Class +=head1 Element Base Class The Apache::lonhelper::element base class provides support for elements and defines some generally useful tags for use in elements. -B +=head2 finalcode tagX Each element can contain a "finalcode" tag that, when the special FINAL helper state is used, will be executed, surrounded by "sub { my $helper = shift;" @@ -762,7 +780,7 @@ may be an empty string. See course initi generally intended for helpers like the course initialization helper, which consist of several panels, each of which is performing some sort of bite-sized functionality. -B +=head2 defaultvalue tagX Each element that accepts user input can contain a "defaultvalue" tag that, when surrounded by "sub { my $helper = shift; my $state = shift; " and "}", @@ -779,7 +797,7 @@ some setting accidentally. Again, see the course initialization helper for examples. -B +=head2 validator tagX Some elements that accepts user input can contain a "validator" tag that, when surrounded by "sub { my $helper = shift; my $state = shift; my $element = shift; my $val = shift " @@ -791,7 +809,7 @@ will return an error message to be displ Consult the documentation for each element to see whether it supports this tag. -B +=head2 getValue methodX If the element stores the name of the variable in a 'variable' member, which the provided ones all do, you can retreive the value of the variable by calling @@ -867,6 +885,7 @@ sub start_defaultvalue { sub end_defaultvalue { return ''; } +# Validators may need to take language specifications sub start_validator { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; @@ -910,20 +929,21 @@ package Apache::lonhelper::message; =pod -=head2 Element: message +=head1 Elements -Message elements display the contents of their tags, and -transition directly to the state in the tag. Example: +=head2 Element: messageX - - GET_NAME - This is the message the user will see, - HTML allowed. +Message elements display their contents, and +transition directly to the state in the attribute. Example: + + + This is the message the user will see, + HTML allowed. -This will display the HTML message and transition to the if +This will display the HTML message and transition to the 'nextstate' if given. The HTML will be directly inserted into the helper, so if you don't -want text to run together, you'll need to manually wrap the +want text to run together, you'll need to manually wrap the message text in

tags, or whatever is appropriate for your HTML. Message tags do not add in whitespace, so if you want it, you'll need to add @@ -935,11 +955,17 @@ within each other.) This is also a good template for creating your own new states, as it has very little code beyond the state template. +=head3 Localization + +The contents of the message tag will be run through the +normalize_string function and that will be used as a call to &mt. + =cut no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::message', @@ -959,8 +985,8 @@ sub start_message { return ''; } - $paramHash->{MESSAGE_TEXT} = &Apache::lonxml::get_all_text('/message', - $parser); + $paramHash->{MESSAGE_TEXT} = &mtn(&Apache::lonxml::get_all_text('/message', + $parser)); if (defined($token->[2]{'nextstate'})) { $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'}; @@ -981,7 +1007,7 @@ sub end_message { sub render { my $self = shift; - return $self->{MESSAGE_TEXT}; + return &mtn($self->{MESSAGE_TEXT}); } # If a NEXTSTATE was given, switch to it sub postprocess { @@ -998,7 +1024,7 @@ package Apache::lonhelper::choices; =pod -=head2 Element: choices +=head2 Element: choicesX Choice states provide a single choice to the user as a text selection box. A "choice" is two pieces of text, one which will be displayed to the user @@ -1016,15 +1042,15 @@ value, will allow the user to select mul value, will allow the user to select none of the choices without raising an error message. -B +=head3 SUB-TAGS - can have the following subtags: + can have the following subtags:X =over 4 =item * state_name: If given, this will cause the - choice element to transition to the given state after executing. If - this is used, do not pass nextstates to the tag. + choice element to transition to the given state after executing. + This will override the passed to (if any). =item * : If the choices are static, this element will allow you to specify them. Each choice @@ -1033,14 +1059,25 @@ B For example, Bobby McDormik. - can take a parameter "eval", which if set to - a true value, will cause the contents of the tag to be - evaluated as it would be in an tag; see tag - below. + can take a parameter "eval", which if set to +a true value, will cause the contents of the tag to be +evaluated as it would be in an tag; see tag +below. may optionally contain a 'nextstate' attribute, which -will be the state transisitoned to if the choice is made, if -the choice is not multichoice. +will be the state transistioned to if the choice is made, if +the choice is not multichoice. This will override the nextstate +passed to the parent C tag. + + 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.: +[2]{'computer'}; - my $human = &Apache::lonxml::get_all_text('/choice', - $parser); - my $nextstate = $token->[2]{'nextstate'}; - my $evalFlag = $token->[2]{'eval'}; - push @{$paramHash->{CHOICES}}, [$human, $computer, $nextstate, - $evalFlag]; + my $human = &mt(&Apache::lonxml::get_all_text('/choice', + $parser)); + 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, $relatedVar, $relatedDefault]; return ''; } @@ -1141,6 +1182,13 @@ sub end_choice { return ''; } +{ + # used to generate unique id attributes for tags. + # internal use only. + my $id = 0; + sub new_id { return $id++; } +} + sub render { my $self = shift; my $var = $self->{'variable'}; @@ -1149,7 +1197,8 @@ sub render { if ($self->{'multichoice'}) { $result .= < + SCRIPT } @@ -1165,10 +1215,13 @@ SCRIPT # Only print "select all" and "unselect all" if there are five or # more choices; fewer then that and it looks silly. if ($self->{'multichoice'} && scalar(@{$self->{CHOICES}}) > 4) { + my %lt=&Apache::lonlocal::texthash( + 'sa' => "Select All", + 'ua' => "Unselect All"); $buttons = < - - + +
  BUTTONS } @@ -1220,22 +1273,31 @@ BUTTONS my $type = "radio"; if ($self->{'multichoice'}) { $type = 'checkbox'; } foreach my $choice (@{$self->{CHOICES}}) { + my $id = &new_id(); $result .= "\n \n"; $result .= "[1],"<>&\"'") . "'"; if ($checkedChoices{$choice->[1]}) { - $result .= " checked "; + $result .= " checked='checked' "; } + $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 .= "/> " . $choiceLabel . "\n"; + $result .= "/> ".qq{"; + if ($choice->[4]) { + $result .=''; + } + $result .= "\n"; } $result .= "\n\n\n"; $result .= $buttons; @@ -1247,11 +1309,11 @@ 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} = "You must choose one or more choices to" . - " continue."; + $self->{ERROR_MSG} = + &mt("You must choose one or more choices to continue."); return 0; } @@ -1269,6 +1331,10 @@ sub postprocess { $helper->changeState($choice->[2]); } } + if ($choice->[4]) { + my $varname = $choice->[4]; + $helper->{'VARS'}->{$varname} = $env{'form.'."$varname.forminput"}; + } } return 1; } @@ -1278,7 +1344,7 @@ package Apache::lonhelper::dropdown; =pod -=head2 Element: dropdown +=head2 Element: dropdownX A drop-down provides a drop-down box instead of a radio button box. Because most people do not know how to use a multi-select @@ -1288,17 +1354,20 @@ are the same as "choices", except "allow takes an attribute "variable" to control which helper variable the result is stored in. -B +=head3 SUB-TAGS , which acts just as it does in the "choices" element. -=back - =cut +# This really ought to be a sibling class to "choice" which is itself +# a child of some abstract class.... *shrug* + no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; +use Apache::lonnet; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::dropdown', @@ -1376,10 +1445,10 @@ sub render { $result .= "\n"; return $result; } @@ -1398,7 +1468,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" . @@ -1425,7 +1495,7 @@ package Apache::lonhelper::date; =pod -=head2 Element: date +=head2 Element: dateX Date elements allow the selection of a date with a drop down list. @@ -1456,7 +1526,8 @@ Example: no strict; @ISA = ("Apache::lonhelper::element"); use strict; - +use Apache::lonlocal; # A localization nightmare +use Apache::lonnet; use Time::localtime; BEGIN { @@ -1484,6 +1555,7 @@ sub start_date { $paramHash->{'variable'} = $token->[2]{'variable'}; $helper->declareVar($paramHash->{'variable'}); $paramHash->{'hoursminutes'} = $token->[2]{'hoursminutes'}; + $paramHash->{'anytime'} = $token->[2]{'anytime'}; } sub end_date { @@ -1502,10 +1574,45 @@ sub render { my $var = $self->{'variable'}; my $date; - + + 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}); + } 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') { + $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(); - $date->min(0); if (defined $self->{ERROR_MSG}) { $result .= '' . $self->{ERROR_MSG} . '

'; @@ -1513,22 +1620,22 @@ sub render { # Month my $i; - $result .= "\n"; for ($i = 0; $i < 12; $i++) { if ($i == $date->mon) { - $result .= "\n"; + $result .= &mt($months[$i]) . "\n"; } $result .= "\n"; # Day - $result .= "\n"; for ($i = 1; $i < 32; $i++) { if ($i == $date->mday) { - $result .= '\n"; for ($i = 1; $i < 12; $i++) { if ($date->hour == $i) { - $result .= "\n"; + $result .= "\n"; } else { - $result .= "\n"; + $result .= "\n"; } } - $result .= "\n"; + $result .= "\n"; for ($i = 13; $i < 24; $i++) { my $printedHour = $i - 12; if ($date->hour == $i) { - $result .= "\n"; + $result .= "\n"; } else { - $result .= "\n"; + $result .= "\n"; } } $result .= " :\n"; - $result .= "\n"; + my $selected=0; + for my $i ((0,15,30,45,59,undef,0..59)) { my $printedMinute = $i; - if ($i < 10) { + if (defined($i) && $i < 10) { $printedMinute = "0" . $printedMinute; } - if ($date->min == $i) { - $result .= "

Inactive students:

\n"; + $result .= < + + + + + +INACTIVEBUTTONS + $result .= "\n"; + + for my $choice (@$expired_students) { + $result .= "\n\n\n\n"; + } + $result .= "
[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], "<>&\"'") + . "' />" + . HTML::Entities::encode($choice->[1],'<>&"') + . "" + . HTML::Entities::encode($choice->[2],'<>&"') + . "" + . HTML::Entities::encode($choice->[3],'<>&"') + . "" + . HTML::Entities::encode($choice->[4],'<>&"') + . "" + . HTML::Entities::encode($choice->[0],'<>&"') + . "
\n"; + + } + + + return $result; } sub postprocess { my $self = shift; - my $result = $ENV{'form.' . $self->{'variable'} . '.forminput'}; - if (!$result) { - $self->{ERROR_MSG} = 'You must choose at least one student '. - 'to continue.'; + my $result = $env{'form.' . $self->{'variable'} . '.forminput'}; + if (!$result && !$self->{'emptyallowed'}) { + if ($self->{'coursepersonnel'}) { + $self->{ERROR_MSG} = + &mt('You must choose at least one user to continue.'); + } else { + $self->{ERROR_MSG} = + &mt('You must choose at least one student to continue.'); + } return 0; } @@ -2101,7 +2674,7 @@ package Apache::lonhelper::files; =pod -=head2 Element: files +=head2 Element: filesX files allows the users to choose files from a given directory on the server. It is always multichoice and stores the result as a triple-pipe @@ -2117,22 +2690,41 @@ are put. It accepts the attribute "multi defaulting to false, which if true will allow the user to select more then one choice. - accepts three subtags. One is the "nextstate" sub-tag that works -as it does with the other tags. Another is a sub tag that -is Perl code that, when surrounded by "sub {" and "}" will return a -string representing what directory on the server to allow the user to -choose files from. Finally, the subtag should contain Perl -code that when surrounded by "sub { my $filename = shift; " and "}", -returns a true value if the user can pick that file, or false otherwise. -The filename passed to the function will be just the name of the file, -with no path info. + accepts three subtags: + +=over 4 + +=item * B: works as it does with the other tags. + +=item * B: When the contents of this tag are surrounded by + "sub {" and "}", will return a string representing what directory + on the server to allow the user to choose files from. + +=item * B: Should contain Perl code that when surrounded + by "sub { my $filename = shift; " and "}", returns a true value if + the user can pick that file, or false otherwise. The filename + passed to the function will be just the name of the file, with no + path info. By default, a filter function will be used that will + mask out old versions of files. This function is available as + Apache::lonhelper::files::not_old_version if you want to use it to + composite your own filters. + +=back + +B: You should ensure the user can not somehow +pass something into your code that would allow them to look places +they should not be able to see, like the C directory. However, +the security impact would be minimal, since it would only expose +the existence of files, there should be no way to parlay that into +viewing the files. =cut no strict; @ISA = ("Apache::lonhelper::element"); use strict; - +use Apache::lonlocal; +use Apache::lonnet; use Apache::lonpubdir; # for getTitleString BEGIN { @@ -2140,6 +2732,18 @@ BEGIN { ('files', 'filechoice', 'filefilter')); } +sub not_old_version { + my $file = shift; + + # Given a file name, return false if it is an "old version" of a + # file, or true if it is not. + + if ($file =~ /^.*\.[0-9]+\.[A-Za-z]+(\.meta)?$/) { + return 0; + } + return 1; +} + sub new { my $ref = Apache::lonhelper::element->new(); bless($ref); @@ -2195,6 +2799,13 @@ sub start_filefilter { sub end_filefilter { return ''; } +{ + # used to generate unique id attributes for tags. + # internal use only. + my $id=0; + sub new_id { return $id++;} +} + sub render { my $self = shift; my $result = ''; @@ -2207,6 +2818,9 @@ sub render { my $subdir = &$subdirFunc(); my $filterFunc = $self->{FILTER_FUNC}; + if (!defined($filterFunc)) { + $filterFunc = ¬_old_version; + } my $buttons = ''; my $type = 'radio'; if ($self->{'multichoice'}) { @@ -2215,7 +2829,8 @@ sub render { if ($self->{'multichoice'}) { $result = < + SCRIPT - $buttons = < "Select All Files", + 'uaf' => "Unselect All Files"); + $buttons = <   - - + + BUTTONS + %lt=&Apache::lonlocal::texthash( + 'sap' => "Select All Published", + 'uap' => "Unselect All Published"); if ($helper->{VARS}->{'construction'}) { - $buttons .= < - + $buttons .= < +
  BUTTONS } @@ -2254,15 +2876,28 @@ BUTTONS my @fileList; # If the subdirectory is in local CSTR space - if ($subdir =~ m|/home/([^/]+)/public_html|) { - my $user = $1; - my $domain = $Apache::lonnet::perlvar{'lonDefDomain'}; + 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 ($user,$domain)= + &Apache::loncacc::constructaccess($subdir, + $Apache::lonnet::perlvar{'lonDefDomain'}); + $metadir='/res/'.$domain.'/'.$user.'/'.$2; @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, ''); } else { # local library server resource space - @fileList = &Apache::lonnet::dirlist($subdir, $ENV{'user.domain'}, $ENV{'user.name'}, ''); + @fileList = &Apache::lonnet::dirlist($subdir, $env{'user.domain'}, $env{'user.name'}, ''); } + # Sort the fileList into order + @fileList = sort {lc($a) cmp lc($b)} @fileList; + $result .= $buttons; if (defined $self->{ERROR_MSG}) { @@ -2292,7 +2927,7 @@ BUTTONS } # Get the title - my $title = Apache::lonpubdir::getTitleString($fileName); + my $title = Apache::lonpubdir::getTitleString(($metadir?$metadir:$subdir) .'/'. $file); # Netscape 4 is stupid and there's nowhere to put the # information on the input tag that the file is Published, @@ -2313,14 +2948,16 @@ BUTTONS if ($status eq 'Published' && $helper->{VARS}->{'construction'}) { $onclick = 'onclick="a=1" '; } + my $id = &new_id(); $result .= '" . "{'multichoice'} && $choices == 0) { - $result .= ' checked'; + $result .= ' checked="checked"'; } - $result .= "/>" . $file . "" . + $result .= "/>". + qq{" . "$title" . "$status" . "\n"; $choices++; @@ -2330,7 +2967,7 @@ BUTTONS $result .= "\n"; if (!$choices) { - $result .= 'There are no files available to select in this directory. Please go back and select another option.

'; + $result .= 'There are no files available to select in this directory ('.$subdir.'). Please go back and select another option.

'; } $result .= $buttons; @@ -2348,10 +2985,14 @@ sub fileState { my $constructionSpaceDir = shift; my $file = shift; + my ($uname,$udom)=($env{'user.name'},$env{'user.domain'}); + if ($env{'request.role'}=~/^ca\./) { + (undef,$udom,$uname)=split(/\//,$env{'request.role'}); + } my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'}; my $subdirpart = $constructionSpaceDir; - $subdirpart =~ s/^\/home\/$ENV{'user.name'}\/public_html//; - my $resdir = $docroot . '/res/' . $ENV{'user.domain'} . '/' . $ENV{'user.name'} . + $subdirpart =~ s/^\/home\/$uname\/public_html//; + my $resdir = $docroot . '/res/' . $udom . '/' . $uname . $subdirpart; my @constructionSpaceFileStat = stat($constructionSpaceDir . '/' . $file); @@ -2371,7 +3012,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.'; @@ -2391,13 +3032,17 @@ package Apache::lonhelper::section; =pod -=head2 Element: section +=head2 Element: sectionX
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 @@ -2427,6 +3072,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'}; } @@ -2446,8 +3092,16 @@ sub start_section { } for my $sectionName (sort(keys(%choices))) { - - push @{$paramHash->{CHOICES}}, [$sectionName, $sectionName]; + push @{$paramHash->{CHOICES}}, [$sectionName, $sectionName]; + } + return if ($token->[2]{'onlysections'}); + + # add in groups to the end of the list + my %curr_groups; + if (&Apache::loncommon::coursegroups(\%curr_groups)) { + foreach my $group_name (sort(keys(%curr_groups))) { + push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]); + } } } @@ -2461,11 +3115,77 @@ sub end_section { } 1; +package Apache::lonhelper::group; + +=pod + +=head2 Element: groupX + + 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. + +=cut + +no strict; +@ISA = ("Apache::lonhelper::choices"); +use strict; + +BEGIN { + &Apache::lonhelper::register('Apache::lonhelper::group', + ('group')); +} + +sub new { + my $ref = Apache::lonhelper::choices->new(); + bless($ref); +} + +sub start_group { + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; + + if ($target ne 'helper') { + return ''; + } + + $paramHash->{CHOICES} = []; + + $paramHash->{'variable'} = $token->[2]{'variable'}; + $helper->declareVar($paramHash->{'variable'}); + $paramHash->{'multichoice'} = $token->[2]{'multichoice'}; + $paramHash->{'allowempty'} = $token->[2]{'allowempty'}; + if (defined($token->[2]{'nextstate'})) { + $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'}; + } + + # Populate the CHOICES element + my %choices; + + my %curr_groups; + if (&Apache::loncommon::coursegroups(\%curr_groups)) { + foreach my $group_name (sort(keys(%curr_groups))) { + push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]); + } + } +} + +sub end_group { + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; + + if ($target ne 'helper') { + return ''; + } + Apache::lonhelper::group->new(); +} +1; + package Apache::lonhelper::string; =pod -=head2 Element: string +=head2 Element: stringX string elements provide a string entry field for the user. string elements take the usual 'variable' and 'nextstate' parameters. string elements @@ -2480,6 +3200,7 @@ string honors the validation function, i no strict; @ISA = ("Apache::lonhelper::element"); use strict; +use Apache::lonlocal; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::string', @@ -2523,7 +3244,7 @@ sub render { my $result = ''; if (defined $self->{ERROR_MSG}) { - $result .= '
' . $self->{ERROR_MSG} . '

'; + $result .= '

' . $self->{ERROR_MSG} . '

'; } $result .= '{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; @@ -2574,10 +3295,10 @@ package Apache::lonhelper::general; =pod -=head2 General-purpose tag: +=head2 General-purpose tag: X -The contents of the exec tag are executed as Perl code, not inside a -safe space, so the full range of $ENV and such is available. The code +The contents of the exec tag are executed as Perl code, B inside a +safe space, so the full range of $env and such is available. The code will be executed as a subroutine wrapped with the following code: "sub { my $helper = shift; my $state = shift;" and @@ -2589,7 +3310,7 @@ The return value is ignored. $helper is the helper object. Feel free to add methods to the helper object to support whatever manipulation you may need to do (for instance, overriding the form location if the state is the final state; see -lonparm.helper for an example). +parameter.helper for an example). $state is the $paramHash that has currently been generated and may be manipulated by the code in exec. Note that the $state is not yet @@ -2598,6 +3319,9 @@ be able to call methods on it. =cut +use Apache::lonlocal; +use Apache::lonnet; + BEGIN { &Apache::lonhelper::register('Apache::lonhelper::general', 'exec', 'condition', 'clause', @@ -2664,7 +3388,7 @@ sub end_clause { return ''; } =pod -=head2 General-purpose tag: +=head2 General-purpose tag: X The tag will be evaluated as a subroutine call passed in the current helper object and state hash as described in above, @@ -2707,10 +3431,10 @@ package Apache::lonhelper::final; =pod -=head2 Element: final +=head2 Element: finalX is a special element that works with helpers that use the -tag. It goes through all the states and elements, executing the +tagX. It goes through all the states and elements, executing the snippets and collecting the results. Finally, it takes the user out of the helper, going to a provided page. @@ -2719,12 +3443,16 @@ will make a "Finish Helper" button that which is useful for the Course Initialization helper so the users never see the old values taking effect. +If the parameter "restartCourse" is not true a 'Finish' Button will be +presented that takes the user back to whatever was defined as + =cut no strict; @ISA = ("Apache::lonhelper::element"); use strict; - +use Apache::lonlocal; +use Apache::lonnet; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::final', ('final', 'exitpage')); @@ -2809,29 +3537,48 @@ sub render { } if (!@results) { - $result .= '
  • No changes were made to current settings.
    • '; + $result .= '
  • ' . + &mt('No changes were made to current settings.') . '
    • '; } $result .= ''; } + my $actionURL = $self->{EXIT_PAGE}; + my $targetURL = ''; + my $finish=&mt('Finish'); if ($self->{'restartCourse'}) { - $result .= "
    \n" . - "
    \n" . - "" . - "" . - "\n" . - "\n\n" . - "
    "; + $actionURL = '/adm/roles'; + $targetURL = '/adm/menu'; + if ($env{'course.'.$env{'request.course.id'}.'.url'}=~/^uploaded/) { + $targetURL = '/adm/coursedocs'; + } else { + $targetURL = '/adm/navmaps'; + } + 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 .= "
    \n" . + "
    \n" . + "" . + "" . + "\n" . + "\n\n" . + "
    "; return $result; } sub overrideForm { - my $self = shift; - return $self->{'restartCourse'}; + return 1; } 1; @@ -2846,6 +3593,8 @@ package Apache::lonhelper::parmwizfinal; no strict; @ISA = ('Apache::lonhelper::element'); use strict; +use Apache::lonlocal; +use Apache::lonnet; BEGIN { &Apache::lonhelper::register('Apache::lonhelper::parmwizfinal', @@ -2876,15 +3625,22 @@ sub render { my $vars = $helper->{VARS}; # FIXME: Unify my designators with the standard ones - my %dateTypeHash = ('open_date' => "Opening Date", - 'due_date' => "Due Date", - 'answer_date' => "Answer Date", - 'tries' => 'Number of Tries' + my %dateTypeHash = ('open_date' => "opening date", + 'due_date' => "due date", + 'answer_date' => "answer date", + 'tries' => 'number of tries', + 'weight' => 'problem weight' ); my %parmTypeHash = ('open_date' => "0_opendate", 'due_date' => "0_duedate", 'answer_date' => "0_answerdate", - 'tries' => '0_maxtries' ); + 'tries' => '0_maxtries', + 'weight' => '0_weight' ); + my %realParmName = ('open_date' => "opendate", + 'due_date' => "duedate", + 'answer_date' => "answerdate", + 'tries' => 'maxtries', + 'weight' => 'weight' ); my $affectedResourceId = ""; my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}}; @@ -2892,11 +3648,17 @@ sub render { my $resourceString; my $symb; my $paramlevel; - + # Print the granularity, depending on the action if ($vars->{GRANULARITY} eq 'whole_course') { - $resourceString .= '
  • for all resources in the course
    • '; - $level = 9; # general course, see lonparmset.pm perldoc + $resourceString .= '
  • '.&mt('for all resources in the course').'
    • '; + if ($vars->{TARGETS} eq 'course') { + $level = 11; # general course, see lonparmset.pm perldoc + } elsif ($vars->{TARGETS} eq 'section') { + $level = 6; + } else { + $level = 3; + } $affectedResourceId = "0.0"; $symb = 'a'; $paramlevel = 'general'; @@ -2905,30 +3667,68 @@ sub render { my $res = $navmap->getByMapPc($vars->{RESOURCE_ID}); my $title = $res->compTitle(); $symb = $res->symb(); - $navmap->untieHashes(); - $resourceString .= "
  • for the map named $title
    • "; - $level = 8; + $resourceString .= '
  • '.&mt('for the map named [_1]',"$title").'
    • '; + if ($vars->{TARGETS} eq 'course') { + $level = 10; # general course, see lonparmset.pm perldoc + } elsif ($vars->{TARGETS} eq 'section') { + $level = 5; + } 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(); - $navmap->untieHashes(); - $resourceString .= "
  • for the resource named $title
    • "; - $level = 7; + $resourceString .= '
  • '.&mt('for the resource named [_1] part [_2]',"$title","$part").'
    • '; + if ($vars->{TARGETS} eq 'course') { + $level = 7; # general course, see lonparmset.pm perldoc + } elsif ($vars->{TARGETS} eq 'section') { + $level = 4; + } else { + $level = 1; + } $affectedResourceId = $vars->{RESOURCE_ID}; $paramlevel = 'full'; } - my $result = "
    \n"; - $result .= '

    Confirm that this information is correct, then click "Finish Wizard" to complete setting the parameter.

      '; + my $result = "\n"; + $result .= "\n"; + $result .= "\n"; + $result .= "\n"; + if ($vars->{GRANULARITY} eq 'resource') { + $result .= "&\"") . "' />\n"; + } elsif ($vars->{GRANULARITY} eq 'map') { + $result .= "\n"; + } + my $part = $vars->{RESOURCE_ID_part}; + if ($part eq 'All Parts' || !$part) { $part=0; } + $result .= "&\"") . "' />\n"; + + $result .= '

      '.&mt('Confirm that this information is correct, then click "Finish Helper" to complete setting the parameter.').'

        '; # Print the type of manipulation: - $result .= '
      • Setting the ' . $dateTypeHash{$vars->{ACTION_TYPE}} . ''; + my $extra; if ($vars->{ACTION_TYPE} eq 'tries') { - $result .= ' to ' . $vars->{TRIES} . ''; + $extra = $vars->{TRIES}; + } + if ($vars->{ACTION_TYPE} eq 'weight') { + $extra = $vars->{WEIGHT}; + } + $result .= "
      • "; + my $what = &mt($dateTypeHash{$vars->{ACTION_TYPE}}); + if ($extra) { + $result .= &mt('Setting the [_1] to [_2]',"$what",$extra); + } else { + $result .= &mt('Setting the [_1]',"$what"); } $result .= "
        • \n"; if ($vars->{ACTION_TYPE} eq 'due_date' || @@ -2950,40 +3750,43 @@ sub render { } elsif ($vars->{ACTION_TYPE} eq 'tries') { $result .= "\n"; + $result .= "\n"; + } elsif ($vars->{ACTION_TYPE} eq 'weight') { + $result .= "\n"; } $result .= $resourceString; # Print targets if ($vars->{TARGETS} eq 'course') { - $result .= '
      • for all students in course
        • '; + $result .= '
      • '.&mt('for all students in course').'
        • '; } elsif ($vars->{TARGETS} eq 'section') { my $section = $vars->{SECTION_NAME}; - $result .= "
      • for section $section
        • "; - $level -= 3; - $result .= "\n"; + $result .= '
      • '.&mt('for section [_1]',"$section").'
        • '; + $result .= "&\"") . "' />\n"; + } elsif ($vars->{TARGETS} eq 'group') { + my $group = $vars->{GROUP_NAME}; + $result .= '
      • '.&mt('for group [_1]',"$group").'
        • '; + $result .= "&\"") . "' />\n"; } else { # FIXME: This is probably wasteful! Store the name! my $classlist = Apache::loncoursedata::get_classlist(); - my $username = $vars->{USER_NAME}; - # Chop off everything after the last colon (section) - $username = substr($username, 0, rindex($username, ':')); - my $name = $classlist->{$username}->[6]; - $result .= "
      • for $name
        • "; - $level -= 6; - my ($uname, $udom) = split /:/, $vars->{USER_NAME}; + my ($uname,$udom)=split(':',$vars->{USER_NAME}); + my $name = $classlist->{$uname.':'.$udom}->[6]; + $result .= '
      • '.&mt('for [_1]',"$name").'
        • '; $result .= "\n"; + HTML::Entities::encode($uname,"'<>&\"") . "' />\n"; $result .= "\n"; + HTML::Entities::encode($udom,"'<>&\"") . "' />\n"; } # Print value - if ($vars->{ACTION_TYPE} ne 'tries') { - $result .= "
      • to " . ctime($vars->{PARM_DATE}) . " (" . - Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}) - . ")
        • \n"; + if ($vars->{ACTION_TYPE} ne 'tries' && $vars->{ACTION_TYPE} ne 'weight') { + $result .= '
      • '.&mt('to [_1] ([_2])',"".ctime($vars->{PARM_DATE})."",Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}))."
        • \n"; } # print pres_marker @@ -2992,11 +3795,10 @@ sub render { # Make the table appear $result .= "\n"; - $result .= "\n"; $result .= "\n"; $result .= "\n"; - $result .= "

        \n"; + $result .= "

        \n"; return $result; }