Annotation of loncom/interface/lonhelper.pm, revision 1.148

1.1       bowersj2    1: # The LearningOnline Network with CAPA
                      2: # .helper XML handler to implement the LON-CAPA helper
                      3: #
1.148   ! foxr        4: # $Id: lonhelper.pm,v 1.147 2006/05/09 22:43:19 foxr Exp $
1.1       bowersj2    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
                     28: 
1.3       bowersj2   29: =pod
                     30: 
1.44      bowersj2   31: =head1 NAME
1.3       bowersj2   32: 
1.44      bowersj2   33: lonhelper - implements helper framework
                     34: 
                     35: =head1 SYNOPSIS
                     36: 
                     37: lonhelper implements the helper framework for LON-CAPA, and provides
                     38:     many generally useful components for that framework.
                     39: 
                     40: Helpers are little programs which present the user with a sequence of
                     41:     simple choices, instead of one monolithic multi-dimensional
                     42:     choice. They are also referred to as "wizards", "druids", and
                     43:     other potentially trademarked or semantically-loaded words.
                     44: 
                     45: =head1 OVERVIEWX<lonhelper>
                     46: 
                     47: Helpers are well-established UI widgets that users
1.3       bowersj2   48: feel comfortable with. It can take a complicated multidimensional problem the
                     49: user has and turn it into a series of bite-sized one-dimensional questions.
                     50: 
                     51: For developers, helpers provide an easy way to bundle little bits of functionality
                     52: for the user, without having to write the tedious state-maintenence code.
                     53: 
                     54: Helpers are defined as XML documents, placed in the /home/httpd/html/adm/helpers 
                     55: directory and having the .helper file extension. For examples, see that directory.
                     56: 
                     57: All classes are in the Apache::lonhelper namespace.
                     58: 
1.44      bowersj2   59: =head1 lonhelper XML file formatX<lonhelper, XML file format>
1.3       bowersj2   60: 
                     61: A helper consists of a top-level <helper> tag which contains a series of states.
                     62: Each state contains one or more state elements, which are what the user sees, like
                     63: messages, resource selections, or date queries.
                     64: 
                     65: The helper tag is required to have one attribute, "title", which is the name
1.31      bowersj2   66: of the helper itself, such as "Parameter helper". The helper tag may optionally
                     67: have a "requiredpriv" attribute, specifying the priviledge a user must have
                     68: to use the helper, or get denied access. See loncom/auth/rolesplain.tab for
                     69: useful privs. Default is full access, which is often wrong!
1.3       bowersj2   70: 
                     71: =head2 State tags
                     72: 
                     73: State tags are required to have an attribute "name", which is the symbolic
1.7       bowersj2   74: name of the state and will not be directly seen by the user. The helper is
                     75: required to have one state named "START", which is the state the helper
1.5       bowersj2   76: will start with. By convention, this state should clearly describe what
1.3       bowersj2   77: the helper will do for the user, and may also include the first information
                     78: entry the user needs to do for the helper.
                     79: 
                     80: State tags are also required to have an attribute "title", which is the
                     81: human name of the state, and will be displayed as the header on top of 
                     82: the screen for the user.
                     83: 
                     84: =head2 Example Helper Skeleton
                     85: 
                     86: An example of the tags so far:
                     87: 
                     88:  <helper title="Example Helper">
                     89:    <state name="START" title="Demonstrating the Example Helper">
                     90:      <!-- notice this is the START state the wizard requires -->
                     91:      </state>
                     92:    <state name="GET_NAME" title="Enter Student Name">
                     93:      </state>
                     94:    </helper>
                     95: 
                     96: Of course this does nothing. In order for the wizard to do something, it is
                     97: necessary to put actual elements into the wizard. Documentation for each
                     98: of these elements follows.
                     99: 
1.44      bowersj2  100: =head1 Creating a Helper With Code, Not XML
1.13      bowersj2  101: 
                    102: In some situations, such as the printing wizard (see lonprintout.pm), 
                    103: writing the helper in XML would be too complicated, because of scope 
                    104: issues or the fact that the code actually outweighs the XML. It is
                    105: possible to create a helper via code, though it is a little odd.
                    106: 
                    107: Creating a helper via code is more like issuing commands to create
                    108: a helper then normal code writing. For instance, elements will automatically
                    109: be added to the last state created, so it's important to create the 
                    110: states in the correct order.
                    111: 
                    112: First, create a new helper:
                    113: 
                    114:  use Apache::lonhelper;
                    115: 
                    116:  my $helper = Apache::lonhelper::new->("Helper Title");
                    117: 
                    118: Next you'll need to manually add states to the helper:
                    119: 
                    120:  Apache::lonhelper::state->new("STATE_NAME", "State's Human Title");
                    121: 
                    122: You don't need to save a reference to it because all elements up until
                    123: the next state creation will automatically be added to this state.
                    124: 
                    125: Elements are created by populating the $paramHash in 
                    126: Apache::lonhelper::paramhash. To prevent namespace issues, retrieve 
                    127: a reference to that has with getParamHash:
                    128: 
                    129:  my $paramHash = Apache::lonhelper::getParamHash();
                    130: 
                    131: You will need to do this for each state you create.
                    132: 
                    133: Populate the $paramHash with the parameters for the element you wish
                    134: to add next; the easiest way to find out what those entries are is
                    135: to read the code. Some common ones are 'variable' to record the variable
                    136: to store the results in, and NEXTSTATE to record a next state transition.
                    137: 
                    138: Then create your element:
                    139: 
                    140:  $paramHash->{MESSAGETEXT} = "This is a message.";
                    141:  Apache::lonhelper::message->new();
                    142: 
                    143: The creation will take the $paramHash and bless it into a
                    144: Apache::lonhelper::message object. To create the next element, you need
                    145: to get a reference to the new, empty $paramHash:
                    146: 
                    147:  $paramHash = Apache::lonhelper::getParamHash();
                    148: 
                    149: and you can repeat creating elements that way. You can add states
                    150: and elements as needed.
                    151: 
                    152: See lonprintout.pm, subroutine printHelper for an example of this, where
                    153: we dynamically add some states to prevent security problems, for instance.
                    154: 
                    155: Normally the machinery in the XML format is sufficient; dynamically 
                    156: adding states can easily be done by wrapping the state in a <condition>
                    157: tag. This should only be used when the code dominates the XML content,
                    158: the code is so complicated that it is difficult to get access to
1.44      bowersj2  159: all of the information you need because of scoping issues, or would-be <exec> or 
                    160: <eval> blocks using the {DATA} mechanism results in hard-to-read
                    161: and -maintain code. (See course.initialization.helper for a borderline
                    162: case.)
1.13      bowersj2  163: 
                    164: It is possible to do some of the work with an XML fragment parsed by
1.17      bowersj2  165: lonxml; again, see lonprintout.pm for an example. In that case it is 
                    166: imperative that you call B<Apache::lonhelper::registerHelperTags()>
                    167: before parsing XML fragments and B<Apache::lonhelper::unregisterHelperTags()>
                    168: when you are done. See lonprintout.pm for examples of this usage in the
                    169: printHelper subroutine.
1.13      bowersj2  170: 
1.57      albertel  171: =head2 Localization
                    172: 
                    173: The helper framework tries to handle as much localization as
                    174: possible. The text is always run through
                    175: Apache::lonlocal::normalize_string, so be sure to run the keys through
                    176: that function for maximum usefulness and robustness.
                    177: 
1.3       bowersj2  178: =cut
                    179: 
1.1       bowersj2  180: package Apache::lonhelper;
1.2       bowersj2  181: use Apache::Constants qw(:common);
                    182: use Apache::File;
1.3       bowersj2  183: use Apache::lonxml;
1.57      albertel  184: use Apache::lonlocal;
1.100     albertel  185: use Apache::lonnet;
1.148   ! foxr      186: use Apache::lonselstudent;
1.139     foxr      187: 
1.7       bowersj2  188: # Register all the tags with the helper, so the helper can 
                    189: # push and pop them
                    190: 
                    191: my @helperTags;
                    192: 
                    193: sub register {
                    194:     my ($namespace, @tags) = @_;
                    195: 
                    196:     for my $tag (@tags) {
                    197:         push @helperTags, [$namespace, $tag];
                    198:     }
                    199: }
                    200: 
1.2       bowersj2  201: BEGIN {
1.7       bowersj2  202:     Apache::lonxml::register('Apache::lonhelper', 
                    203:                              ('helper'));
                    204:       register('Apache::lonhelper', ('state'));
1.2       bowersj2  205: }
                    206: 
1.7       bowersj2  207: # Since all helpers are only three levels deep (helper tag, state tag, 
1.3       bowersj2  208: # substate type), it's easier and more readble to explicitly track 
                    209: # those three things directly, rather then futz with the tag stack 
                    210: # every time.
                    211: my $helper;
                    212: my $state;
                    213: my $substate;
1.4       bowersj2  214: # To collect parameters, the contents of the subtags are collected
                    215: # into this paramHash, then passed to the element object when the 
                    216: # end of the element tag is located.
                    217: my $paramHash; 
1.2       bowersj2  218: 
1.25      bowersj2  219: # Note from Jeremy 5-8-2003: It is *vital* that the real handler be called
                    220: # as a subroutine from the handler, or very mysterious things might happen.
                    221: # I don't know exactly why, but it seems that the scope where the Apache
                    222: # server enters the perl handler is treated differently from the rest of
                    223: # the handler. This also seems to manifest itself in the debugger as entering
                    224: # the perl handler in seemingly random places (sometimes it starts in the
                    225: # compiling phase, sometimes in the handler execution phase where it runs
                    226: # the code and stepping into the "1;" the module ends with goes into the handler,
                    227: # sometimes starting directly with the handler); I think the cause is related.
                    228: # In the debugger, this means that breakpoints are ignored until you step into
                    229: # a function and get out of what must be a "faked up scope" in the Apache->
                    230: # mod_perl connection. In this code, it was manifesting itself in the existence
1.65      www       231: # of two separate file-scoped $helper variables, one set to the value of the
1.25      bowersj2  232: # helper in the helper constructor, and one referenced by the handler on the
1.44      bowersj2  233: # "$helper->process()" line. Using the debugger, one could actually
                    234: # see the two different $helper variables, as hashes at completely
                    235: # different addresses. The second was therefore never set, and was still
1.25      bowersj2  236: # undefined when I tried to call process on it.
                    237: # By pushing the "real handler" down into the "real scope", everybody except the 
                    238: # actual handler function directly below this comment gets the same $helper and
                    239: # everybody is happy.
                    240: # The upshot of all of this is that for safety when a handler is  using 
                    241: # file-scoped variables in LON-CAPA, the handler should be pushed down one 
                    242: # call level, as I do here, to ensure that the top-level handler function does
                    243: # not get a different file scope from the rest of the code.
                    244: sub handler {
                    245:     my $r = shift;
                    246:     return real_handler($r);
                    247: }
                    248: 
1.13      bowersj2  249: # For debugging purposes, one can send a second parameter into this
                    250: # function, the 'uri' of the helper you wish to have rendered, and
                    251: # call this from other handlers.
1.25      bowersj2  252: sub real_handler {
1.3       bowersj2  253:     my $r = shift;
1.13      bowersj2  254:     my $uri = shift;
                    255:     if (!defined($uri)) { $uri = $r->uri(); }
1.100     albertel  256:     $env{'request.uri'} = $uri;
1.13      bowersj2  257:     my $filename = '/home/httpd/html' . $uri;
1.2       bowersj2  258:     my $fh = Apache::File->new($filename);
                    259:     my $file;
1.3       bowersj2  260:     read $fh, $file, 100000000;
                    261: 
1.27      bowersj2  262: 
1.3       bowersj2  263:     # Send header, don't cache this page
1.100     albertel  264:     if ($env{'browser.mathml'}) {
1.70      sakharuk  265: 	&Apache::loncommon::content_type($r,'text/xml');
                    266:     } else {
                    267: 	&Apache::loncommon::content_type($r,'text/html');
                    268:     }
                    269:     $r->send_http_header;
                    270:     return OK if $r->header_only;
1.3       bowersj2  271:     $r->rflush();
1.2       bowersj2  272: 
1.3       bowersj2  273:     # Discard result, we just want the objects that get created by the
                    274:     # xml parsing
                    275:     &Apache::lonxml::xmlparse($r, 'helper', $file);
1.2       bowersj2  276: 
1.31      bowersj2  277:     my $allowed = $helper->allowedCheck();
                    278:     if (!$allowed) {
1.100     albertel  279:         $env{'user.error.msg'} = $env{'request.uri'}.':'.$helper->{REQUIRED_PRIV}.
1.31      bowersj2  280:             ":0:0:Permission denied to access this helper.";
                    281:         return HTTP_NOT_ACCEPTABLE;
                    282:     }
                    283: 
1.13      bowersj2  284:     $helper->process();
                    285: 
1.3       bowersj2  286:     $r->print($helper->display());
1.31      bowersj2  287:     return OK;
1.2       bowersj2  288: }
                    289: 
1.13      bowersj2  290: sub registerHelperTags {
                    291:     for my $tagList (@helperTags) {
                    292:         Apache::lonxml::register($tagList->[0], $tagList->[1]);
                    293:     }
                    294: }
                    295: 
                    296: sub unregisterHelperTags {
                    297:     for my $tagList (@helperTags) {
                    298:         Apache::lonxml::deregister($tagList->[0], $tagList->[1]);
                    299:     }
                    300: }
                    301: 
1.2       bowersj2  302: sub start_helper {
                    303:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    304: 
                    305:     if ($target ne 'helper') {
                    306:         return '';
                    307:     }
1.7       bowersj2  308: 
1.13      bowersj2  309:     registerHelperTags();
                    310: 
1.31      bowersj2  311:     Apache::lonhelper::helper->new($token->[2]{'title'}, $token->[2]{'requiredpriv'});
1.4       bowersj2  312:     return '';
1.2       bowersj2  313: }
                    314: 
                    315: sub end_helper {
                    316:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    317:     
1.3       bowersj2  318:     if ($target ne 'helper') {
                    319:         return '';
                    320:     }
1.7       bowersj2  321: 
1.13      bowersj2  322:     unregisterHelperTags();
1.7       bowersj2  323: 
1.4       bowersj2  324:     return '';
1.2       bowersj2  325: }
1.1       bowersj2  326: 
1.3       bowersj2  327: sub start_state {
                    328:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    329: 
                    330:     if ($target ne 'helper') {
                    331:         return '';
                    332:     }
                    333: 
1.13      bowersj2  334:     Apache::lonhelper::state->new($token->[2]{'name'},
                    335:                                   $token->[2]{'title'});
1.3       bowersj2  336:     return '';
                    337: }
                    338: 
1.13      bowersj2  339: # Use this to get the param hash from other files.
                    340: sub getParamHash {
                    341:     return $paramHash;
                    342: }
                    343: 
                    344: # Use this to get the helper, if implementing elements in other files
                    345: # (like lonprintout.pm)
                    346: sub getHelper {
                    347:     return $helper;
                    348: }
                    349: 
1.3       bowersj2  350: # don't need this, so ignore it
                    351: sub end_state {
                    352:     return '';
                    353: }
                    354: 
1.1       bowersj2  355: 1;
                    356: 
1.3       bowersj2  357: package Apache::lonhelper::helper;
                    358: 
                    359: use Digest::MD5 qw(md5_hex);
1.57      albertel  360: use HTML::Entities();
1.3       bowersj2  361: use Apache::loncommon;
                    362: use Apache::File;
1.57      albertel  363: use Apache::lonlocal;
1.100     albertel  364: use Apache::lonnet;
1.3       bowersj2  365: 
                    366: sub new {
                    367:     my $proto = shift;
                    368:     my $class = ref($proto) || $proto;
                    369:     my $self = {};
                    370: 
                    371:     $self->{TITLE} = shift;
1.31      bowersj2  372:     $self->{REQUIRED_PRIV} = shift;
1.3       bowersj2  373:     
                    374:     # If there is a state from the previous form, use that. If there is no
                    375:     # state, use the start state parameter.
1.100     albertel  376:     if (defined $env{"form.CURRENT_STATE"})
1.3       bowersj2  377:     {
1.100     albertel  378: 	$self->{STATE} = $env{"form.CURRENT_STATE"};
1.3       bowersj2  379:     }
                    380:     else
                    381:     {
                    382: 	$self->{STATE} = "START";
                    383:     }
                    384: 
1.100     albertel  385:     $self->{TOKEN} = $env{'form.TOKEN'};
1.3       bowersj2  386:     # If a token was passed, we load that in. Otherwise, we need to create a 
                    387:     # new storage file
                    388:     # Tried to use standard Tie'd hashes, but you can't seem to take a 
                    389:     # reference to a tied hash and write to it. I'd call that a wart.
                    390:     if ($self->{TOKEN}) {
                    391:         # Validate the token before trusting it
                    392:         if ($self->{TOKEN} !~ /^[a-f0-9]{32}$/) {
                    393:             # Not legit. Return nothing and let all hell break loose.
                    394:             # User shouldn't be doing that!
                    395:             return undef;
                    396:         }
                    397: 
                    398:         # Get the hash.
                    399:         $self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN}); # Note the token is not the literal file
                    400:         
                    401:         my $file = Apache::File->new($self->{FILENAME});
                    402:         my $contents = <$file>;
1.5       bowersj2  403: 
                    404:         # Now load in the contents
                    405:         for my $value (split (/&/, $contents)) {
                    406:             my ($name, $value) = split(/=/, $value);
                    407:             $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg;
                    408:             $self->{VARS}->{$name} = $value;
                    409:         }
                    410: 
1.3       bowersj2  411:         $file->close();
                    412:     } else {
                    413:         # Only valid if we're just starting.
                    414:         if ($self->{STATE} ne 'START') {
                    415:             return undef;
                    416:         }
                    417:         # Must create the storage
1.100     albertel  418:         $self->{TOKEN} = md5_hex($env{'user.name'} . $env{'user.domain'} .
1.3       bowersj2  419:                                  time() . rand());
                    420:         $self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN});
                    421:     }
                    422: 
                    423:     # OK, we now have our persistent storage.
                    424: 
1.100     albertel  425:     if (defined $env{"form.RETURN_PAGE"})
1.3       bowersj2  426:     {
1.100     albertel  427: 	$self->{RETURN_PAGE} = $env{"form.RETURN_PAGE"};
1.3       bowersj2  428:     }
                    429:     else
                    430:     {
                    431: 	$self->{RETURN_PAGE} = $ENV{REFERER};
                    432:     }
                    433: 
                    434:     $self->{STATES} = {};
                    435:     $self->{DONE} = 0;
                    436: 
1.9       bowersj2  437:     # Used by various helpers for various things; see lonparm.helper
                    438:     # for an example.
                    439:     $self->{DATA} = {};
                    440: 
1.13      bowersj2  441:     $helper = $self;
                    442: 
                    443:     # Establish the $paramHash
                    444:     $paramHash = {};
                    445: 
1.3       bowersj2  446:     bless($self, $class);
                    447:     return $self;
                    448: }
                    449: 
                    450: # Private function; returns a string to construct the hidden fields
                    451: # necessary to have the helper track state.
                    452: sub _saveVars {
                    453:     my $self = shift;
                    454:     my $result = "";
                    455:     $result .= '<input type="hidden" name="CURRENT_STATE" value="' .
1.67      albertel  456:         HTML::Entities::encode($self->{STATE},'<>&"') . "\" />\n";
1.3       bowersj2  457:     $result .= '<input type="hidden" name="TOKEN" value="' .
                    458:         $self->{TOKEN} . "\" />\n";
                    459:     $result .= '<input type="hidden" name="RETURN_PAGE" value="' .
1.67      albertel  460:         HTML::Entities::encode($self->{RETURN_PAGE},'<>&"') . "\" />\n";
1.3       bowersj2  461: 
                    462:     return $result;
                    463: }
                    464: 
                    465: # Private function: Create the querystring-like representation of the stored
                    466: # data to write to disk.
                    467: sub _varsInFile {
                    468:     my $self = shift;
                    469:     my @vars = ();
                    470:     for my $key (keys %{$self->{VARS}}) {
                    471:         push @vars, &Apache::lonnet::escape($key) . '=' .
                    472:             &Apache::lonnet::escape($self->{VARS}->{$key});
                    473:     }
                    474:     return join ('&', @vars);
                    475: }
                    476: 
1.5       bowersj2  477: # Use this to declare variables.
                    478: # FIXME: Document this
                    479: sub declareVar {
                    480:     my $self = shift;
                    481:     my $var = shift;
                    482: 
                    483:     if (!defined($self->{VARS}->{$var})) {
                    484:         $self->{VARS}->{$var} = '';
                    485:     }
                    486: 
                    487:     my $envname = 'form.' . $var . '.forminput';
1.100     albertel  488:     if (defined($env{$envname})) {
                    489:         if (ref($env{$envname})) {
                    490:             $self->{VARS}->{$var} = join('|||', @{$env{$envname}});
1.28      bowersj2  491:         } else {
1.100     albertel  492:             $self->{VARS}->{$var} = $env{$envname};
1.28      bowersj2  493:         }
1.5       bowersj2  494:     }
                    495: }
                    496: 
1.31      bowersj2  497: sub allowedCheck {
                    498:     my $self = shift;
                    499: 
                    500:     if (!defined($self->{REQUIRED_PRIV})) { 
                    501:         return 1;
                    502:     }
                    503: 
1.100     albertel  504:     return Apache::lonnet::allowed($self->{REQUIRED_PRIV}, $env{'request.course.id'});
1.31      bowersj2  505: }
                    506: 
1.3       bowersj2  507: sub changeState {
                    508:     my $self = shift;
                    509:     $self->{STATE} = shift;
                    510: }
                    511: 
                    512: sub registerState {
                    513:     my $self = shift;
                    514:     my $state = shift;
                    515: 
                    516:     my $stateName = $state->name();
                    517:     $self->{STATES}{$stateName} = $state;
                    518: }
                    519: 
1.13      bowersj2  520: sub process {
1.3       bowersj2  521:     my $self = shift;
                    522: 
                    523:     # Phase 1: Post processing for state of previous screen (which is actually
                    524:     # the "current state" in terms of the helper variables), if it wasn't the 
                    525:     # beginning state.
1.100     albertel  526:     if ($self->{STATE} ne "START" || $env{"form.SUBMIT"} eq &mt("Next ->")) {
1.3       bowersj2  527: 	my $prevState = $self->{STATES}{$self->{STATE}};
1.13      bowersj2  528:         $prevState->postprocess();
1.3       bowersj2  529:     }
                    530:     
                    531:     # Note, to handle errors in a state's input that a user must correct,
                    532:     # do not transition in the postprocess, and force the user to correct
                    533:     # the error.
                    534: 
                    535:     # Phase 2: Preprocess current state
                    536:     my $startState = $self->{STATE};
1.17      bowersj2  537:     my $state = $self->{STATES}->{$startState};
1.3       bowersj2  538:     
1.13      bowersj2  539:     # For debugging, print something here to determine if you're going
                    540:     # to an undefined state.
1.3       bowersj2  541:     if (!defined($state)) {
1.13      bowersj2  542:         return;
1.3       bowersj2  543:     }
                    544:     $state->preprocess();
                    545: 
                    546:     # Phase 3: While the current state is different from the previous state,
                    547:     # keep processing.
1.17      bowersj2  548:     while ( $startState ne $self->{STATE} && 
                    549:             defined($self->{STATES}->{$self->{STATE}}) )
1.3       bowersj2  550:     {
                    551: 	$startState = $self->{STATE};
1.17      bowersj2  552: 	$state = $self->{STATES}->{$startState};
1.3       bowersj2  553: 	$state->preprocess();
                    554:     }
                    555: 
1.13      bowersj2  556:     return;
                    557: } 
                    558: 
                    559: # 1: Do the post processing for the previous state.
                    560: # 2: Do the preprocessing for the current state.
                    561: # 3: Check to see if state changed, if so, postprocess current and move to next.
                    562: #    Repeat until state stays stable.
                    563: # 4: Render the current state to the screen as an HTML page.
                    564: sub display {
                    565:     my $self = shift;
                    566: 
                    567:     my $state = $self->{STATES}{$self->{STATE}};
                    568: 
                    569:     my $result = "";
                    570: 
1.17      bowersj2  571:     if (!defined($state)) {
                    572:         $result = "<font color='#ff0000'>Error: state '$state' not defined!</font>";
                    573:         return $result;
                    574:     }
                    575: 
1.3       bowersj2  576:     # Phase 4: Display.
1.68      sakharuk  577:     my $stateTitle=&mt($state->title());
1.135     albertel  578:     my $browser_searcher_js = 
                    579: 	'<script type="text/javascript">'."\n".
                    580: 	&Apache::loncommon::browser_and_searcher_javascript().
                    581: 	"\n".'</script>';
                    582: 
                    583:     $result .= &Apache::loncommon::start_page($self->{TITLE},
                    584: 					      $browser_searcher_js);
                    585:     
1.57      albertel  586:     my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
                    587:     my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
                    588:     # FIXME: This should be parameterized, not concatenated - Jeremy
1.3       bowersj2  589: 
1.135     albertel  590: 
1.28      bowersj2  591:     if (!$state->overrideForm()) { $result.="<form name='helpform' method='POST'>"; }
1.3       bowersj2  592:     $result .= <<HEADER;
1.31      bowersj2  593:         <table border="0" width='100%'><tr><td>
1.3       bowersj2  594:         <h2><i>$stateTitle</i></h2>
                    595: HEADER
                    596: 
1.31      bowersj2  597:     $result .= "<table cellpadding='10' width='100%'><tr><td rowspan='2' valign='top'>";
1.30      bowersj2  598: 
1.3       bowersj2  599:     if (!$state->overrideForm()) {
                    600:         $result .= $self->_saveVars();
                    601:     }
1.30      bowersj2  602:     $result .= $state->render();
                    603: 
1.31      bowersj2  604:     $result .= "</td><td valign='top' align='right'>";
1.3       bowersj2  605: 
1.30      bowersj2  606:     # Warning: Copy and pasted from below, because it's too much trouble to 
                    607:     # turn this into a subroutine
1.3       bowersj2  608:     if (!$state->overrideForm()) {
                    609:         if ($self->{STATE} ne $self->{START_STATE}) {
                    610:             #$result .= '<input name="SUBMIT" type="submit" value="&lt;- Previous" />&nbsp;&nbsp;';
                    611:         }
                    612:         if ($self->{DONE}) {
                    613:             my $returnPage = $self->{RETURN_PAGE};
1.57      albertel  614:             $result .= "<a href=\"$returnPage\">" . &mt("End Helper") . "</a>";
1.3       bowersj2  615:         }
                    616:         else {
1.30      bowersj2  617:             $result .= '<nobr><input name="back" type="button" ';
1.57      albertel  618:             $result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
                    619:             $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
1.30      bowersj2  620:         }
                    621:     }
                    622: 
1.31      bowersj2  623:     $result .= "</td></tr><tr><td valign='bottom' align='right'>";
1.30      bowersj2  624: 
                    625:     # Warning: Copy and pasted from above, because it's too much trouble to 
                    626:     # turn this into a subroutine
                    627:     if (!$state->overrideForm()) {
                    628:         if ($self->{STATE} ne $self->{START_STATE}) {
                    629:             #$result .= '<input name="SUBMIT" type="submit" value="&lt;- Previous" />&nbsp;&nbsp;';
                    630:         }
                    631:         if ($self->{DONE}) {
                    632:             my $returnPage = $self->{RETURN_PAGE};
1.57      albertel  633:             $result .= "<a href=\"$returnPage\">" . &mt('End Helper') . "</a>";
1.30      bowersj2  634:         }
                    635:         else {
                    636:             $result .= '<nobr><input name="back" type="button" ';
1.57      albertel  637:             $result .= 'value="' . $previous . '" onclick="history.go(-1)" /> ';
                    638:             $result .= '<input name="SUBMIT" type="submit" value="' . $next . '" /></nobr>';
1.3       bowersj2  639:         }
                    640:     }
                    641: 
1.13      bowersj2  642:     #foreach my $key (keys %{$self->{VARS}}) {
                    643:     #    $result .= "|$key| -> " . $self->{VARS}->{$key} . "<br />";
                    644:     #}
1.5       bowersj2  645: 
1.30      bowersj2  646:     $result .= "</td></tr></table>";
                    647: 
1.3       bowersj2  648:     $result .= <<FOOTER;
                    649:               </td>
                    650:             </tr>
                    651:           </table>
                    652:         </form>
                    653: FOOTER
                    654: 
1.135     albertel  655:     $result .= &Apache::loncommon::end_page();
1.3       bowersj2  656:     # Handle writing out the vars to the file
                    657:     my $file = Apache::File->new('>'.$self->{FILENAME});
1.33      bowersj2  658:     print $file $self->_varsInFile();
1.3       bowersj2  659: 
                    660:     return $result;
                    661: }
                    662: 
                    663: 1;
                    664: 
                    665: package Apache::lonhelper::state;
                    666: 
                    667: # States bundle things together and are responsible for compositing the
1.4       bowersj2  668: # various elements together. It is not generally necessary for users to
                    669: # use the state object directly, so it is not perldoc'ed.
                    670: 
                    671: # Basically, all the states do is pass calls to the elements and aggregate
                    672: # the results.
1.3       bowersj2  673: 
                    674: sub new {
                    675:     my $proto = shift;
                    676:     my $class = ref($proto) || $proto;
                    677:     my $self = {};
                    678: 
                    679:     $self->{NAME} = shift;
                    680:     $self->{TITLE} = shift;
                    681:     $self->{ELEMENTS} = [];
                    682: 
                    683:     bless($self, $class);
                    684: 
                    685:     $helper->registerState($self);
                    686: 
1.13      bowersj2  687:     $state = $self;
                    688: 
1.3       bowersj2  689:     return $self;
                    690: }
                    691: 
                    692: sub name {
                    693:     my $self = shift;
                    694:     return $self->{NAME};
                    695: }
                    696: 
                    697: sub title {
                    698:     my $self = shift;
                    699:     return $self->{TITLE};
                    700: }
                    701: 
1.4       bowersj2  702: sub preprocess {
                    703:     my $self = shift;
                    704:     for my $element (@{$self->{ELEMENTS}}) {
                    705:         $element->preprocess();
                    706:     }
                    707: }
                    708: 
1.6       bowersj2  709: # FIXME: Document that all postprocesses must return a true value or
                    710: # the state transition will be overridden
1.4       bowersj2  711: sub postprocess {
                    712:     my $self = shift;
1.6       bowersj2  713: 
                    714:     # Save the state so we can roll it back if we need to.
                    715:     my $originalState = $helper->{STATE};
                    716:     my $everythingSuccessful = 1;
                    717: 
1.4       bowersj2  718:     for my $element (@{$self->{ELEMENTS}}) {
1.6       bowersj2  719:         my $result = $element->postprocess();
                    720:         if (!$result) { $everythingSuccessful = 0; }
                    721:     }
                    722: 
                    723:     # If not all the postprocesses were successful, override
                    724:     # any state transitions that may have occurred. It is the
                    725:     # responsibility of the states to make sure they have 
                    726:     # error handling in that case.
                    727:     if (!$everythingSuccessful) {
                    728:         $helper->{STATE} = $originalState;
1.4       bowersj2  729:     }
                    730: }
                    731: 
1.13      bowersj2  732: # Override the form if any element wants to.
                    733: # two elements overriding the form will make a mess, but that should
                    734: # be considered helper author error ;-)
1.4       bowersj2  735: sub overrideForm {
1.13      bowersj2  736:     my $self = shift;
                    737:     for my $element (@{$self->{ELEMENTS}}) {
                    738:         if ($element->overrideForm()) {
                    739:             return 1;
                    740:         }
                    741:     }
1.4       bowersj2  742:     return 0;
                    743: }
                    744: 
                    745: sub addElement {
                    746:     my $self = shift;
                    747:     my $element = shift;
                    748:     
                    749:     push @{$self->{ELEMENTS}}, $element;
                    750: }
                    751: 
                    752: sub render {
                    753:     my $self = shift;
                    754:     my @results = ();
                    755: 
                    756:     for my $element (@{$self->{ELEMENTS}}) {
                    757:         push @results, $element->render();
                    758:     }
1.28      bowersj2  759: 
1.4       bowersj2  760:     return join("\n", @results);
                    761: }
                    762: 
                    763: 1;
                    764: 
                    765: package Apache::lonhelper::element;
                    766: # Support code for elements
                    767: 
                    768: =pod
                    769: 
1.44      bowersj2  770: =head1 Element Base Class
1.4       bowersj2  771: 
1.28      bowersj2  772: The Apache::lonhelper::element base class provides support for elements
                    773: and defines some generally useful tags for use in elements.
1.4       bowersj2  774: 
1.44      bowersj2  775: =head2 finalcode tagX<finalcode>
1.25      bowersj2  776: 
                    777: Each element can contain a "finalcode" tag that, when the special FINAL
                    778: helper state is used, will be executed, surrounded by "sub { my $helper = shift;"
                    779: and "}". It is expected to return a string describing what it did, which 
                    780: may be an empty string. See course initialization helper for an example. This is
                    781: generally intended for helpers like the course initialization helper, which consist
                    782: of several panels, each of which is performing some sort of bite-sized functionality.
                    783: 
1.44      bowersj2  784: =head2 defaultvalue tagX<defaultvalue>
1.25      bowersj2  785: 
                    786: Each element that accepts user input can contain a "defaultvalue" tag that,
                    787: when surrounded by "sub { my $helper = shift; my $state = shift; " and "}",
                    788: will form a subroutine that when called will provide a default value for
                    789: the element. How this value is interpreted by the element is specific to
                    790: the element itself, and possibly the settings the element has (such as 
                    791: multichoice vs. single choice for <choices> tags). 
                    792: 
                    793: This is also intended for things like the course initialization wizard, where the
                    794: user is setting various parameters. By correctly grabbing current settings 
                    795: and including them into the helper, it allows the user to come back to the
                    796: helper later and re-execute it, without needing to worry about overwriting
                    797: some setting accidentally.
                    798: 
                    799: Again, see the course initialization helper for examples.
                    800: 
1.44      bowersj2  801: =head2 validator tagX<validator>
1.38      bowersj2  802: 
                    803: Some elements that accepts user input can contain a "validator" tag that,
                    804: when surrounded by "sub { my $helper = shift; my $state = shift; my $element = shift; my $val = shift " 
                    805: and "}", where "$val" is the value the user entered, will form a subroutine 
                    806: that when called will verify whether the given input is valid or not. If it 
                    807: is valid, the routine will return a false value. If invalid, the routine 
                    808: will return an error message to be displayed for the user.
                    809: 
                    810: Consult the documentation for each element to see whether it supports this 
                    811: tag.
                    812: 
1.44      bowersj2  813: =head2 getValue methodX<getValue (helper elements)>
1.31      bowersj2  814: 
                    815: If the element stores the name of the variable in a 'variable' member, which
                    816: the provided ones all do, you can retreive the value of the variable by calling
                    817: this method.
                    818: 
1.4       bowersj2  819: =cut
                    820: 
1.5       bowersj2  821: BEGIN {
1.7       bowersj2  822:     &Apache::lonhelper::register('Apache::lonhelper::element',
1.25      bowersj2  823:                                  ('nextstate', 'finalcode',
1.38      bowersj2  824:                                   'defaultvalue', 'validator'));
1.5       bowersj2  825: }
                    826: 
1.4       bowersj2  827: # Because we use the param hash, this is often a sufficent
                    828: # constructor
                    829: sub new {
                    830:     my $proto = shift;
                    831:     my $class = ref($proto) || $proto;
                    832:     my $self = $paramHash;
                    833:     bless($self, $class);
                    834: 
                    835:     $self->{PARAMS} = $paramHash;
                    836:     $self->{STATE} = $state;
                    837:     $state->addElement($self);
                    838:     
                    839:     # Ensure param hash is not reused
                    840:     $paramHash = {};
                    841: 
                    842:     return $self;
                    843: }   
                    844: 
1.5       bowersj2  845: sub start_nextstate {
                    846:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    847: 
                    848:     if ($target ne 'helper') {
                    849:         return '';
                    850:     }
                    851:     
                    852:     $paramHash->{NEXTSTATE} = &Apache::lonxml::get_all_text('/nextstate',
                    853:                                                              $parser);
                    854:     return '';
                    855: }
                    856: 
                    857: sub end_nextstate { return ''; }
                    858: 
1.25      bowersj2  859: sub start_finalcode {
                    860:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    861: 
                    862:     if ($target ne 'helper') {
                    863:         return '';
                    864:     }
                    865:     
                    866:     $paramHash->{FINAL_CODE} = &Apache::lonxml::get_all_text('/finalcode',
                    867:                                                              $parser);
                    868:     return '';
                    869: }
                    870: 
                    871: sub end_finalcode { return ''; }
                    872: 
                    873: sub start_defaultvalue {
                    874:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    875: 
                    876:     if ($target ne 'helper') {
                    877:         return '';
                    878:     }
                    879:     
                    880:     $paramHash->{DEFAULT_VALUE} = &Apache::lonxml::get_all_text('/defaultvalue',
                    881:                                                              $parser);
                    882:     $paramHash->{DEFAULT_VALUE} = 'sub { my $helper = shift; my $state = shift;' .
                    883:         $paramHash->{DEFAULT_VALUE} . '}';
                    884:     return '';
                    885: }
                    886: 
                    887: sub end_defaultvalue { return ''; }
                    888: 
1.57      albertel  889: # Validators may need to take language specifications
1.38      bowersj2  890: sub start_validator {
                    891:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    892: 
                    893:     if ($target ne 'helper') {
                    894:         return '';
                    895:     }
                    896:     
                    897:     $paramHash->{VALIDATOR} = &Apache::lonxml::get_all_text('/validator',
                    898:                                                              $parser);
                    899:     $paramHash->{VALIDATOR} = 'sub { my $helper = shift; my $state = shift; my $element = shift; my $val = shift;' .
                    900:         $paramHash->{VALIDATOR} . '}';
                    901:     return '';
                    902: }
                    903: 
                    904: sub end_validator { return ''; }
                    905: 
1.4       bowersj2  906: sub preprocess {
                    907:     return 1;
                    908: }
                    909: 
                    910: sub postprocess {
                    911:     return 1;
                    912: }
                    913: 
                    914: sub render {
                    915:     return '';
                    916: }
                    917: 
1.13      bowersj2  918: sub overrideForm {
                    919:     return 0;
                    920: }
                    921: 
1.31      bowersj2  922: sub getValue {
                    923:     my $self = shift;
                    924:     return $helper->{VARS}->{$self->{'variable'}};
                    925: }
                    926: 
1.4       bowersj2  927: 1;
                    928: 
                    929: package Apache::lonhelper::message;
                    930: 
                    931: =pod
                    932: 
1.48      bowersj2  933: =head1 Elements
                    934: 
                    935: =head2 Element: messageX<message, helper element>
1.4       bowersj2  936: 
1.44      bowersj2  937: Message elements display their contents, and
                    938: transition directly to the state in the <nextstate> attribute. Example:
1.4       bowersj2  939: 
1.44      bowersj2  940:  <message nextstate='GET_NAME'>
                    941:    This is the <b>message</b> the user will see, 
                    942:                  <i>HTML allowed</i>.
1.4       bowersj2  943:    </message>
                    944: 
1.44      bowersj2  945: This will display the HTML message and transition to the 'nextstate' if
1.7       bowersj2  946: given. The HTML will be directly inserted into the helper, so if you don't
1.44      bowersj2  947: want text to run together, you'll need to manually wrap the message text
1.4       bowersj2  948: in <p> tags, or whatever is appropriate for your HTML.
                    949: 
1.5       bowersj2  950: Message tags do not add in whitespace, so if you want it, you'll need to add
                    951: it into states. This is done so you can inline some elements, such as 
                    952: the <date> element, right between two messages, giving the appearence that 
                    953: the <date> element appears inline. (Note the elements can not be embedded
                    954: within each other.)
                    955: 
1.4       bowersj2  956: This is also a good template for creating your own new states, as it has
                    957: very little code beyond the state template.
                    958: 
1.57      albertel  959: =head3 Localization
                    960: 
                    961: The contents of the message tag will be run through the
                    962: normalize_string function and that will be used as a call to &mt.
                    963: 
1.4       bowersj2  964: =cut
                    965: 
                    966: no strict;
                    967: @ISA = ("Apache::lonhelper::element");
                    968: use strict;
1.57      albertel  969: use Apache::lonlocal;
1.4       bowersj2  970: 
                    971: BEGIN {
1.7       bowersj2  972:     &Apache::lonhelper::register('Apache::lonhelper::message',
1.10      bowersj2  973:                               ('message'));
1.3       bowersj2  974: }
                    975: 
1.5       bowersj2  976: sub new {
                    977:     my $ref = Apache::lonhelper::element->new();
                    978:     bless($ref);
                    979: }
1.4       bowersj2  980: 
                    981: # CONSTRUCTION: Construct the message element from the XML
                    982: sub start_message {
                    983:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    984: 
                    985:     if ($target ne 'helper') {
                    986:         return '';
                    987:     }
1.10      bowersj2  988: 
1.69      sakharuk  989:     $paramHash->{MESSAGE_TEXT} = &mtn(&Apache::lonxml::get_all_text('/message',
                    990:                                                                $parser));
1.10      bowersj2  991: 
                    992:     if (defined($token->[2]{'nextstate'})) {
                    993:         $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
                    994:     }
1.4       bowersj2  995:     return '';
1.3       bowersj2  996: }
                    997: 
1.10      bowersj2  998: sub end_message {
1.4       bowersj2  999:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1000: 
                   1001:     if ($target ne 'helper') {
                   1002:         return '';
                   1003:     }
1.10      bowersj2 1004:     Apache::lonhelper::message->new();
                   1005:     return '';
1.5       bowersj2 1006: }
                   1007: 
                   1008: sub render {
                   1009:     my $self = shift;
                   1010: 
1.57      albertel 1011:     return &mtn($self->{MESSAGE_TEXT});
1.5       bowersj2 1012: }
                   1013: # If a NEXTSTATE was given, switch to it
                   1014: sub postprocess {
                   1015:     my $self = shift;
                   1016:     if (defined($self->{NEXTSTATE})) {
                   1017:         $helper->changeState($self->{NEXTSTATE});
                   1018:     }
1.6       bowersj2 1019: 
                   1020:     return 1;
1.5       bowersj2 1021: }
                   1022: 1;
                   1023: 
                   1024: package Apache::lonhelper::choices;
                   1025: 
                   1026: =pod
                   1027: 
1.44      bowersj2 1028: =head2 Element: choicesX<choices, helper element>
1.5       bowersj2 1029: 
                   1030: Choice states provide a single choice to the user as a text selection box.
                   1031: A "choice" is two pieces of text, one which will be displayed to the user
                   1032: (the "human" value), and one which will be passed back to the program
                   1033: (the "computer" value). For instance, a human may choose from a list of
                   1034: resources on disk by title, while your program wants the file name.
                   1035: 
                   1036: <choices> takes an attribute "variable" to control which helper variable
                   1037: the result is stored in.
                   1038: 
                   1039: <choices> takes an attribute "multichoice" which, if set to a true
                   1040: value, will allow the user to select multiple choices.
                   1041: 
1.26      bowersj2 1042: <choices> takes an attribute "allowempty" which, if set to a true 
                   1043: value, will allow the user to select none of the choices without raising
                   1044: an error message.
                   1045: 
1.44      bowersj2 1046: =head3 SUB-TAGS
1.5       bowersj2 1047: 
1.44      bowersj2 1048: <choices> can have the following subtags:X<choice, helper tag>
1.5       bowersj2 1049: 
                   1050: =over 4
                   1051: 
                   1052: =item * <nextstate>state_name</nextstate>: If given, this will cause the
1.44      bowersj2 1053:       choice element to transition to the given state after executing.
                   1054:       This will override the <nextstate> passed to <choices> (if any).
1.5       bowersj2 1055: 
                   1056: =item * <choice />: If the choices are static,
                   1057:       this element will allow you to specify them. Each choice
                   1058:       contains  attribute, "computer", as described above. The
                   1059:       content of the tag will be used as the human label.
                   1060:       For example,  
                   1061:       <choice computer='234-12-7312'>Bobby McDormik</choice>.
                   1062: 
1.44      bowersj2 1063: <choice> can take a parameter "eval", which if set to
                   1064: a true value, will cause the contents of the tag to be
                   1065: evaluated as it would be in an <eval> tag; see <eval> tag
                   1066: below.
1.13      bowersj2 1067: 
1.5       bowersj2 1068: <choice> may optionally contain a 'nextstate' attribute, which
1.44      bowersj2 1069: will be the state transistioned to if the choice is made, if
                   1070: the choice is not multichoice. This will override the nextstate
                   1071: passed to the parent C<choices> tag.
1.5       bowersj2 1072: 
1.136     foxr     1073: <choice> may optionally contain a 'relatedvalue' attribute, which
                   1074: if present will cause a text entry to appear to the right of the
                   1075: selection.  The value of the relatedvalue attribute is a variable
                   1076: into which the text entry will be stored e.g.:
                   1077: <choice computer='numberprovided" relatedvalue="num">Type the number in:</choice>
                   1078: 
                   1079: <choice> may contain a relatededefault atribute which, if the
                   1080: relatedvalue attribute is present will be the initial value of the input
                   1081: box.
                   1082: 
1.5       bowersj2 1083: =back
                   1084: 
                   1085: To create the choices programmatically, either wrap the choices in 
                   1086: <condition> tags (prefered), or use an <exec> block inside the <choice>
                   1087: tag. Store the choices in $state->{CHOICES}, which is a list of list
                   1088: references, where each list has three strings. The first is the human
                   1089: name, the second is the computer name. and the third is the option
                   1090: next state. For example:
                   1091: 
                   1092:  <exec>
                   1093:     for (my $i = 65; $i < 65 + 26; $i++) {
                   1094:         push @{$state->{CHOICES}}, [chr($i), $i, 'next'];
                   1095:     }
                   1096:  </exec>
                   1097: 
                   1098: This will allow the user to select from the letters A-Z (in ASCII), while
                   1099: passing the ASCII value back into the helper variables, and the state
                   1100: will in all cases transition to 'next'.
                   1101: 
                   1102: You can mix and match methods of creating choices, as long as you always 
                   1103: "push" onto the choice list, rather then wiping it out. (You can even 
                   1104: remove choices programmatically, but that would probably be bad form.)
                   1105: 
1.44      bowersj2 1106: =head3 defaultvalue support
1.25      bowersj2 1107: 
                   1108: Choices supports default values both in multichoice and single choice mode.
                   1109: In single choice mode, have the defaultvalue tag's function return the 
                   1110: computer value of the box you want checked. If the function returns a value
                   1111: that does not correspond to any of the choices, the default behavior of selecting
                   1112: the first choice will be preserved.
                   1113: 
                   1114: For multichoice, return a string with the computer values you want checked,
                   1115: delimited by triple pipes. Note this matches how the result of the <choices>
                   1116: tag is stored in the {VARS} hash.
                   1117: 
1.5       bowersj2 1118: =cut
                   1119: 
                   1120: no strict;
                   1121: @ISA = ("Apache::lonhelper::element");
                   1122: use strict;
1.57      albertel 1123: use Apache::lonlocal;
1.100     albertel 1124: use Apache::lonnet;
1.5       bowersj2 1125: 
                   1126: BEGIN {
1.7       bowersj2 1127:     &Apache::lonhelper::register('Apache::lonhelper::choices',
1.5       bowersj2 1128:                               ('choice', 'choices'));
                   1129: }
                   1130: 
                   1131: sub new {
                   1132:     my $ref = Apache::lonhelper::element->new();
                   1133:     bless($ref);
                   1134: }
                   1135: 
                   1136: # CONSTRUCTION: Construct the message element from the XML
                   1137: sub start_choices {
                   1138:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1139: 
                   1140:     if ($target ne 'helper') {
                   1141:         return '';
                   1142:     }
                   1143: 
                   1144:     # Need to initialize the choices list, so everything can assume it exists
1.24      sakharuk 1145:     $paramHash->{'variable'} = $token->[2]{'variable'} if (!defined($paramHash->{'variable'}));
1.5       bowersj2 1146:     $helper->declareVar($paramHash->{'variable'});
                   1147:     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
1.26      bowersj2 1148:     $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
1.5       bowersj2 1149:     $paramHash->{CHOICES} = [];
                   1150:     return '';
                   1151: }
                   1152: 
                   1153: sub end_choices {
                   1154:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1155: 
                   1156:     if ($target ne 'helper') {
                   1157:         return '';
                   1158:     }
                   1159:     Apache::lonhelper::choices->new();
                   1160:     return '';
                   1161: }
                   1162: 
                   1163: sub start_choice {
                   1164:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1165: 
                   1166:     if ($target ne 'helper') {
                   1167:         return '';
                   1168:     }
                   1169: 
                   1170:     my $computer = $token->[2]{'computer'};
1.69      sakharuk 1171:     my $human = &mt(&Apache::lonxml::get_all_text('/choice',
                   1172:                                               $parser));
1.136     foxr     1173:     my $nextstate  = $token->[2]{'nextstate'};
                   1174:     my $evalFlag   = $token->[2]{'eval'};
                   1175:     my $relatedVar = $token->[2]{'relatedvalue'}; 
                   1176:     my $relatedDefault = $token->[2]{'relateddefault'};
1.94      albertel 1177:     push @{$paramHash->{CHOICES}}, [&mtn($human), $computer, $nextstate, 
1.136     foxr     1178:                                     $evalFlag, $relatedVar, $relatedDefault];
1.5       bowersj2 1179:     return '';
                   1180: }
                   1181: 
                   1182: sub end_choice {
                   1183:     return '';
                   1184: }
                   1185: 
1.87      matthew  1186: {
                   1187:     # used to generate unique id attributes for <input> tags. 
                   1188:     # internal use only.
                   1189:     my $id = 0;
                   1190:     sub new_id { return $id++; }
                   1191: }
                   1192: 
1.5       bowersj2 1193: sub render {
                   1194:     my $self = shift;
                   1195:     my $var = $self->{'variable'};
                   1196:     my $buttons = '';
                   1197:     my $result = '';
                   1198: 
                   1199:     if ($self->{'multichoice'}) {
1.6       bowersj2 1200:         $result .= <<SCRIPT;
1.112     albertel 1201: <script type="text/javascript">
                   1202: // <!--
1.18      bowersj2 1203:     function checkall(value, checkName) {
1.15      bowersj2 1204: 	for (i=0; i<document.forms.helpform.elements.length; i++) {
1.18      bowersj2 1205:             ele = document.forms.helpform.elements[i];
                   1206:             if (ele.name == checkName + '.forminput') {
                   1207:                 document.forms.helpform.elements[i].checked=value;
                   1208:             }
1.5       bowersj2 1209:         }
                   1210:     }
1.112     albertel 1211: // -->
1.5       bowersj2 1212: </script>
                   1213: SCRIPT
1.25      bowersj2 1214:     }
                   1215: 
                   1216:     # Only print "select all" and "unselect all" if there are five or
                   1217:     # more choices; fewer then that and it looks silly.
                   1218:     if ($self->{'multichoice'} && scalar(@{$self->{CHOICES}}) > 4) {
1.68      sakharuk 1219:         my %lt=&Apache::lonlocal::texthash(
                   1220: 			'sa'  => "Select All",
                   1221: 		        'ua'  => "Unselect All");
1.5       bowersj2 1222:         $buttons = <<BUTTONS;
                   1223: <br />
1.68      sakharuk 1224: <input type="button" onclick="checkall(true, '$var')" value="$lt{'sa'}" />
                   1225: <input type="button" onclick="checkall(false, '$var')" value="$lt{'ua'}" />
1.6       bowersj2 1226: <br />&nbsp;
1.5       bowersj2 1227: BUTTONS
                   1228:     }
                   1229: 
1.16      bowersj2 1230:     if (defined $self->{ERROR_MSG}) {
1.6       bowersj2 1231:         $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br />';
1.5       bowersj2 1232:     }
                   1233: 
                   1234:     $result .= $buttons;
1.6       bowersj2 1235:     
1.5       bowersj2 1236:     $result .= "<table>\n\n";
                   1237: 
1.25      bowersj2 1238:     my %checkedChoices;
                   1239:     my $checkedChoicesFunc;
                   1240: 
                   1241:     if (defined($self->{DEFAULT_VALUE})) {
                   1242:         $checkedChoicesFunc = eval ($self->{DEFAULT_VALUE});
                   1243:         die 'Error in default value code for variable ' . 
1.34      bowersj2 1244:             $self->{'variable'} . ', Perl said: ' . $@ if $@;
1.25      bowersj2 1245:     } else {
                   1246:         $checkedChoicesFunc = sub { return ''; };
                   1247:     }
                   1248: 
                   1249:     # Process which choices should be checked.
                   1250:     if ($self->{'multichoice'}) {
                   1251:         for my $selectedChoice (split(/\|\|\|/, (&$checkedChoicesFunc($helper, $self)))) {
                   1252:             $checkedChoices{$selectedChoice} = 1;
                   1253:         }
                   1254:     } else {
                   1255:         # single choice
                   1256:         my $selectedChoice = &$checkedChoicesFunc($helper, $self);
                   1257:         
                   1258:         my $foundChoice = 0;
                   1259:         
                   1260:         # check that the choice is in the list of choices.
                   1261:         for my $choice (@{$self->{CHOICES}}) {
                   1262:             if ($choice->[1] eq $selectedChoice) {
                   1263:                 $checkedChoices{$choice->[1]} = 1;
                   1264:                 $foundChoice = 1;
                   1265:             }
                   1266:         }
                   1267:         
                   1268:         # If we couldn't find the choice, pick the first one 
                   1269:         if (!$foundChoice) {
                   1270:             $checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
                   1271:         }
                   1272:     }
                   1273: 
1.5       bowersj2 1274:     my $type = "radio";
                   1275:     if ($self->{'multichoice'}) { $type = 'checkbox'; }
                   1276:     foreach my $choice (@{$self->{CHOICES}}) {
1.87      matthew  1277:         my $id = &new_id();
1.5       bowersj2 1278:         $result .= "<tr>\n<td width='20'>&nbsp;</td>\n";
                   1279:         $result .= "<td valign='top'><input type='$type' name='$var.forminput'"
1.111     albertel 1280:             . " value='" . 
1.89      foxr     1281:             HTML::Entities::encode($choice->[1],"<>&\"'") 
1.5       bowersj2 1282:             . "'";
1.25      bowersj2 1283:         if ($checkedChoices{$choice->[1]}) {
1.111     albertel 1284:             $result .= " checked='checked' ";
1.5       bowersj2 1285:         }
1.111     albertel 1286:         $result .= qq{id="id$id"};
1.13      bowersj2 1287:         my $choiceLabel = $choice->[0];
1.136     foxr     1288:         if ($choice->[3]) {  # if we need to evaluate this choice
1.13      bowersj2 1289:             $choiceLabel = "sub { my $helper = shift; my $state = shift;" .
                   1290:                 $choiceLabel . "}";
                   1291:             $choiceLabel = eval($choiceLabel);
                   1292:             $choiceLabel = &$choiceLabel($helper, $self);
                   1293:         }
1.111     albertel 1294:         $result .= "/></td><td> ".qq{<label for="id$id">}.
1.136     foxr     1295:             $choiceLabel. "</label></td>";
                   1296: 	if ($choice->[4]) {
                   1297: 	    $result .='<td><input type="text" size="5" name="'
                   1298: 		.$choice->[4].'.forminput" value="'
                   1299:                 .$choice->[5].'" /></td>';
                   1300: 	}
                   1301: 	$result .= "</tr>\n";
1.5       bowersj2 1302:     }
                   1303:     $result .= "</table>\n\n\n";
                   1304:     $result .= $buttons;
                   1305: 
                   1306:     return $result;
                   1307: }
                   1308: 
                   1309: # If a NEXTSTATE was given or a nextstate for this choice was
                   1310: # given, switch to it
                   1311: sub postprocess {
                   1312:     my $self = shift;
1.100     albertel 1313:     my $chosenValue = $env{'form.' . $self->{'variable'} . '.forminput'};
1.5       bowersj2 1314: 
1.26      bowersj2 1315:     if (!defined($chosenValue) && !$self->{'allowempty'}) {
1.59      bowersj2 1316:         $self->{ERROR_MSG} = 
                   1317: 	    &mt("You must choose one or more choices to continue.");
1.6       bowersj2 1318:         return 0;
                   1319:     }
                   1320: 
1.28      bowersj2 1321:     if (ref($chosenValue)) {
                   1322:         $helper->{VARS}->{$self->{'variable'}} = join('|||', @$chosenValue);
1.42      bowersj2 1323:     }
                   1324: 
                   1325:     if (defined($self->{NEXTSTATE})) {
                   1326:         $helper->changeState($self->{NEXTSTATE});
                   1327:     }
                   1328:     
                   1329:     foreach my $choice (@{$self->{CHOICES}}) {
                   1330:         if ($choice->[1] eq $chosenValue) {
                   1331:             if (defined($choice->[2])) {
                   1332:                 $helper->changeState($choice->[2]);
                   1333:             }
                   1334:         }
1.136     foxr     1335: 	if ($choice->[4]) {
                   1336: 	    my $varname = $choice->[4];
                   1337: 	    $helper->{'VARS'}->{$varname} = $env{'form.'."$varname.forminput"};
                   1338: 	}
1.42      bowersj2 1339:     }
                   1340:     return 1;
                   1341: }
                   1342: 1;
                   1343: 
                   1344: package Apache::lonhelper::dropdown;
                   1345: 
                   1346: =pod
                   1347: 
1.44      bowersj2 1348: =head2 Element: dropdownX<dropdown, helper tag>
1.42      bowersj2 1349: 
                   1350: A drop-down provides a drop-down box instead of a radio button
                   1351: box. Because most people do not know how to use a multi-select
                   1352: drop-down box, that option is not allowed. Otherwise, the arguments
                   1353: are the same as "choices", except "allowempty" is also meaningless.
                   1354: 
                   1355: <dropdown> takes an attribute "variable" to control which helper variable
                   1356: the result is stored in.
                   1357: 
1.44      bowersj2 1358: =head3 SUB-TAGS
1.42      bowersj2 1359: 
                   1360: <choice>, which acts just as it does in the "choices" element.
                   1361: 
                   1362: =cut
                   1363: 
1.57      albertel 1364: # This really ought to be a sibling class to "choice" which is itself
                   1365: # a child of some abstract class.... *shrug*
                   1366: 
1.42      bowersj2 1367: no strict;
                   1368: @ISA = ("Apache::lonhelper::element");
                   1369: use strict;
1.57      albertel 1370: use Apache::lonlocal;
1.100     albertel 1371: use Apache::lonnet;
1.42      bowersj2 1372: 
                   1373: BEGIN {
                   1374:     &Apache::lonhelper::register('Apache::lonhelper::dropdown',
                   1375:                               ('dropdown'));
                   1376: }
                   1377: 
                   1378: sub new {
                   1379:     my $ref = Apache::lonhelper::element->new();
                   1380:     bless($ref);
                   1381: }
                   1382: 
                   1383: # CONSTRUCTION: Construct the message element from the XML
                   1384: sub start_dropdown {
                   1385:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1386: 
                   1387:     if ($target ne 'helper') {
                   1388:         return '';
                   1389:     }
                   1390: 
                   1391:     # Need to initialize the choices list, so everything can assume it exists
                   1392:     $paramHash->{'variable'} = $token->[2]{'variable'} if (!defined($paramHash->{'variable'}));
                   1393:     $helper->declareVar($paramHash->{'variable'});
                   1394:     $paramHash->{CHOICES} = [];
                   1395:     return '';
                   1396: }
                   1397: 
                   1398: sub end_dropdown {
                   1399:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1400: 
                   1401:     if ($target ne 'helper') {
                   1402:         return '';
                   1403:     }
                   1404:     Apache::lonhelper::dropdown->new();
                   1405:     return '';
                   1406: }
                   1407: 
                   1408: sub render {
                   1409:     my $self = shift;
                   1410:     my $var = $self->{'variable'};
                   1411:     my $result = '';
                   1412: 
                   1413:     if (defined $self->{ERROR_MSG}) {
                   1414:         $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br />';
                   1415:     }
                   1416: 
                   1417:     my %checkedChoices;
                   1418:     my $checkedChoicesFunc;
                   1419: 
                   1420:     if (defined($self->{DEFAULT_VALUE})) {
                   1421:         $checkedChoicesFunc = eval ($self->{DEFAULT_VALUE});
                   1422:         die 'Error in default value code for variable ' . 
                   1423:             $self->{'variable'} . ', Perl said: ' . $@ if $@;
                   1424:     } else {
                   1425:         $checkedChoicesFunc = sub { return ''; };
                   1426:     }
                   1427: 
                   1428:     # single choice
                   1429:     my $selectedChoice = &$checkedChoicesFunc($helper, $self);
                   1430:     
                   1431:     my $foundChoice = 0;
                   1432:     
                   1433:     # check that the choice is in the list of choices.
                   1434:     for my $choice (@{$self->{CHOICES}}) {
                   1435: 	if ($choice->[1] eq $selectedChoice) {
                   1436: 	    $checkedChoices{$choice->[1]} = 1;
                   1437: 	    $foundChoice = 1;
                   1438: 	}
                   1439:     }
                   1440:     
                   1441:     # If we couldn't find the choice, pick the first one 
                   1442:     if (!$foundChoice) {
                   1443: 	$checkedChoices{$self->{CHOICES}->[0]->[1]} = 1;
                   1444:     }
                   1445: 
                   1446:     $result .= "<select name='${var}.forminput'>\n";
                   1447:     foreach my $choice (@{$self->{CHOICES}}) {
                   1448:         $result .= "<option value='" . 
1.89      foxr     1449:             HTML::Entities::encode($choice->[1],"<>&\"'") 
1.42      bowersj2 1450:             . "'";
                   1451:         if ($checkedChoices{$choice->[1]}) {
1.111     albertel 1452:             $result .= " selected='selected' ";
1.42      bowersj2 1453:         }
                   1454:         my $choiceLabel = $choice->[0];
                   1455:         if ($choice->[4]) {  # if we need to evaluate this choice
                   1456:             $choiceLabel = "sub { my $helper = shift; my $state = shift;" .
                   1457:                 $choiceLabel . "}";
                   1458:             $choiceLabel = eval($choiceLabel);
                   1459:             $choiceLabel = &$choiceLabel($helper, $self);
                   1460:         }
1.112     albertel 1461:         $result .= ">" . &mtn($choiceLabel) . "</option>\n";
1.42      bowersj2 1462:     }
1.43      bowersj2 1463:     $result .= "</select>\n";
1.42      bowersj2 1464: 
                   1465:     return $result;
                   1466: }
                   1467: 
                   1468: # If a NEXTSTATE was given or a nextstate for this choice was
                   1469: # given, switch to it
                   1470: sub postprocess {
                   1471:     my $self = shift;
1.100     albertel 1472:     my $chosenValue = $env{'form.' . $self->{'variable'} . '.forminput'};
1.42      bowersj2 1473: 
                   1474:     if (!defined($chosenValue) && !$self->{'allowempty'}) {
                   1475:         $self->{ERROR_MSG} = "You must choose one or more choices to" .
                   1476:             " continue.";
                   1477:         return 0;
1.6       bowersj2 1478:     }
                   1479: 
1.5       bowersj2 1480:     if (defined($self->{NEXTSTATE})) {
                   1481:         $helper->changeState($self->{NEXTSTATE});
                   1482:     }
                   1483:     
                   1484:     foreach my $choice (@{$self->{CHOICES}}) {
                   1485:         if ($choice->[1] eq $chosenValue) {
                   1486:             if (defined($choice->[2])) {
                   1487:                 $helper->changeState($choice->[2]);
                   1488:             }
                   1489:         }
                   1490:     }
1.6       bowersj2 1491:     return 1;
1.5       bowersj2 1492: }
                   1493: 1;
                   1494: 
                   1495: package Apache::lonhelper::date;
                   1496: 
                   1497: =pod
                   1498: 
1.44      bowersj2 1499: =head2 Element: dateX<date, helper element>
1.5       bowersj2 1500: 
                   1501: Date elements allow the selection of a date with a drop down list.
                   1502: 
                   1503: Date elements can take two attributes:
                   1504: 
                   1505: =over 4
                   1506: 
                   1507: =item * B<variable>: The name of the variable to store the chosen
                   1508:         date in. Required.
                   1509: 
                   1510: =item * B<hoursminutes>: If a true value, the date will show hours
                   1511:         and minutes, as well as month/day/year. If false or missing,
                   1512:         the date will only show the month, day, and year.
                   1513: 
                   1514: =back
                   1515: 
                   1516: Date elements contain only an option <nextstate> tag to determine
                   1517: the next state.
                   1518: 
                   1519: Example:
                   1520: 
                   1521:  <date variable="DUE_DATE" hoursminutes="1">
                   1522:    <nextstate>choose_why</nextstate>
                   1523:    </date>
                   1524: 
                   1525: =cut
                   1526: 
                   1527: no strict;
                   1528: @ISA = ("Apache::lonhelper::element");
                   1529: use strict;
1.57      albertel 1530: use Apache::lonlocal; # A localization nightmare
1.100     albertel 1531: use Apache::lonnet;
1.5       bowersj2 1532: use Time::localtime;
                   1533: 
                   1534: BEGIN {
1.7       bowersj2 1535:     &Apache::lonhelper::register('Apache::lonhelper::date',
1.5       bowersj2 1536:                               ('date'));
                   1537: }
                   1538: 
                   1539: # Don't need to override the "new" from element
                   1540: sub new {
                   1541:     my $ref = Apache::lonhelper::element->new();
                   1542:     bless($ref);
                   1543: }
                   1544: 
                   1545: my @months = ("January", "February", "March", "April", "May", "June", "July",
                   1546: 	      "August", "September", "October", "November", "December");
                   1547: 
                   1548: # CONSTRUCTION: Construct the message element from the XML
                   1549: sub start_date {
                   1550:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1551: 
                   1552:     if ($target ne 'helper') {
                   1553:         return '';
                   1554:     }
                   1555: 
                   1556:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   1557:     $helper->declareVar($paramHash->{'variable'});
                   1558:     $paramHash->{'hoursminutes'} = $token->[2]{'hoursminutes'};
1.118     albertel 1559:     $paramHash->{'anytime'} = $token->[2]{'anytime'};
1.5       bowersj2 1560: }
                   1561: 
                   1562: sub end_date {
                   1563:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1564: 
                   1565:     if ($target ne 'helper') {
                   1566:         return '';
                   1567:     }
                   1568:     Apache::lonhelper::date->new();
                   1569:     return '';
                   1570: }
                   1571: 
                   1572: sub render {
                   1573:     my $self = shift;
                   1574:     my $result = "";
                   1575:     my $var = $self->{'variable'};
                   1576: 
                   1577:     my $date;
1.118     albertel 1578: 
                   1579:     my $time=time;
1.119     albertel 1580:     my ($anytime,$onclick);
1.118     albertel 1581: 
1.137     albertel 1582: 
                   1583:     # first check VARS for a valid new value from the user
                   1584:     # then check DEFAULT_VALUE for a valid default time value
                   1585:     # otherwise pick now as reasonably good time
                   1586: 
                   1587:     if (defined($helper->{VARS}{$var})
                   1588: 	&&  $helper->{VARS}{$var} > 0) {
                   1589: 	$date = localtime($helper->{VARS}{$var});
                   1590:     } elsif (defined($self->{DEFAULT_VALUE})) {
1.118     albertel 1591:         my $valueFunc = eval($self->{DEFAULT_VALUE});
                   1592:         die('Error in default value code for variable ' . 
                   1593:             $self->{'variable'} . ', Perl said: ' . $@) if $@;
                   1594:         $time = &$valueFunc($helper, $self);
1.130     albertel 1595: 	if (lc($time) eq 'anytime') {
                   1596: 	    $anytime=1;
1.137     albertel 1597: 	    $date = localtime(time);
                   1598: 	    $date->min(0);
                   1599: 	} elsif (defined($time) && $time ne 0) {
                   1600: 	    $date = localtime($time);
1.130     albertel 1601: 	} else {
1.137     albertel 1602: 	    # leave date undefined so it'll default to now
1.130     albertel 1603: 	}
1.137     albertel 1604:     }
1.130     albertel 1605: 
1.138     albertel 1606:     if (!defined($date)) {
1.137     albertel 1607: 	$date = localtime(time);
                   1608: 	$date->min(0);
1.118     albertel 1609:     }
1.137     albertel 1610: 
                   1611:     &Apache::lonnet::logthis("date mode ");
                   1612: 
1.119     albertel 1613:     if ($anytime) {
                   1614: 	$onclick = "onclick=\"javascript:updateCheck(this.form,'${var}anytime',false)\"";
                   1615:     }
1.5       bowersj2 1616:     # Default date: The current hour.
                   1617: 
                   1618:     if (defined $self->{ERROR_MSG}) {
                   1619:         $result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
                   1620:     }
                   1621: 
                   1622:     # Month
                   1623:     my $i;
1.119     albertel 1624:     $result .= "<select $onclick name='${var}month'>\n";
1.5       bowersj2 1625:     for ($i = 0; $i < 12; $i++) {
                   1626:         if ($i == $date->mon) {
1.111     albertel 1627:             $result .= "<option value='$i' selected='selected'>";
1.5       bowersj2 1628:         } else {
                   1629:             $result .= "<option value='$i'>";
                   1630:         }
1.57      albertel 1631:         $result .= &mt($months[$i]) . "</option>\n";
1.5       bowersj2 1632:     }
                   1633:     $result .= "</select>\n";
                   1634: 
                   1635:     # Day
1.119     albertel 1636:     $result .= "<select $onclick name='${var}day'>\n";
1.5       bowersj2 1637:     for ($i = 1; $i < 32; $i++) {
                   1638:         if ($i == $date->mday) {
1.111     albertel 1639:             $result .= '<option selected="selected">';
1.5       bowersj2 1640:         } else {
                   1641:             $result .= '<option>';
                   1642:         }
                   1643:         $result .= "$i</option>\n";
                   1644:     }
                   1645:     $result .= "</select>,\n";
                   1646: 
                   1647:     # Year
1.119     albertel 1648:     $result .= "<select $onclick name='${var}year'>\n";
1.5       bowersj2 1649:     for ($i = 2000; $i < 2030; $i++) { # update this after 64-bit dates
                   1650:         if ($date->year + 1900 == $i) {
1.111     albertel 1651:             $result .= "<option selected='selected'>";
1.5       bowersj2 1652:         } else {
                   1653:             $result .= "<option>";
                   1654:         }
                   1655:         $result .= "$i</option>\n";
                   1656:     }
                   1657:     $result .= "</select>,\n";
                   1658: 
                   1659:     # Display Hours and Minutes if they are called for
                   1660:     if ($self->{'hoursminutes'}) {
1.59      bowersj2 1661: 	# This needs parameterization for times.
                   1662: 	my $am = &mt('a.m.');
                   1663: 	my $pm = &mt('p.m.');
1.5       bowersj2 1664:         # Build hour
1.119     albertel 1665:         $result .= "<select $onclick name='${var}hour'>\n";
1.111     albertel 1666:         $result .= "<option " . ($date->hour == 0 ? 'selected="selected" ':'') .
1.59      bowersj2 1667:             " value='0'>" . &mt('midnight') . "</option>\n";
1.5       bowersj2 1668:         for ($i = 1; $i < 12; $i++) {
                   1669:             if ($date->hour == $i) {
1.111     albertel 1670:                 $result .= "<option selected='selected' value='$i'>$i $am</option>\n";
1.5       bowersj2 1671:             } else {
1.59      bowersj2 1672:                 $result .= "<option value='$i'>$i $am</option>\n";
1.5       bowersj2 1673:             }
                   1674:         }
1.111     albertel 1675:         $result .= "<option " . ($date->hour == 12 ? 'selected="selected" ':'') .
1.59      bowersj2 1676:             " value='12'>" . &mt('noon') . "</option>\n";
1.5       bowersj2 1677:         for ($i = 13; $i < 24; $i++) {
                   1678:             my $printedHour = $i - 12;
                   1679:             if ($date->hour == $i) {
1.111     albertel 1680:                 $result .= "<option selected='selected' value='$i'>$printedHour $pm</option>\n";
1.5       bowersj2 1681:             } else {
1.59      bowersj2 1682:                 $result .= "<option value='$i'>$printedHour $pm</option>\n";
1.5       bowersj2 1683:             }
                   1684:         }
                   1685: 
                   1686:         $result .= "</select> :\n";
                   1687: 
1.119     albertel 1688:         $result .= "<select $onclick name='${var}minute'>\n";
1.120     albertel 1689: 	my $selected=0;
                   1690:         for my $i ((0,15,30,45,59,undef,0..59)) {
1.5       bowersj2 1691:             my $printedMinute = $i;
1.117     albertel 1692:             if (defined($i) && $i < 10) {
1.5       bowersj2 1693:                 $printedMinute = "0" . $printedMinute;
                   1694:             }
1.120     albertel 1695:             if (!$selected && $date->min == $i) {
1.111     albertel 1696:                 $result .= "<option selected='selected'>";
1.120     albertel 1697: 		$selected=1;
1.5       bowersj2 1698:             } else {
                   1699:                 $result .= "<option>";
                   1700:             }
                   1701:             $result .= "$printedMinute</option>\n";
                   1702:         }
                   1703:         $result .= "</select>\n";
                   1704:     }
1.118     albertel 1705:     if ($self->{'anytime'}) {
1.121     albertel 1706: 	$result.=(<<CHECK);
1.119     albertel 1707: <script type="text/javascript">
                   1708: // <!--
                   1709:     function updateCheck(form,name,value) {
                   1710: 	var checkbox=form[name];
                   1711: 	checkbox.checked = value;
                   1712:     }
                   1713: // -->
                   1714: </script>
                   1715: CHECK
1.118     albertel 1716: 	$result.="&nbsp;or&nbsp;<label><input type='checkbox' ";
                   1717: 	if ($anytime) {
                   1718: 	    $result.=' checked="checked" '
                   1719: 	}
1.138     albertel 1720: 	$result.="name='${var}anytime'/>".&mt('Any time').'</label>'
1.118     albertel 1721:     }
1.5       bowersj2 1722:     return $result;
                   1723: 
                   1724: }
                   1725: # If a NEXTSTATE was given, switch to it
                   1726: sub postprocess {
                   1727:     my $self = shift;
                   1728:     my $var = $self->{'variable'};
1.118     albertel 1729:     if ($env{'form.' . $var . 'anytime'}) {
                   1730: 	$helper->{VARS}->{$var} = undef;
                   1731:     } else {
                   1732: 	my $month = $env{'form.' . $var . 'month'}; 
                   1733: 	my $day = $env{'form.' . $var . 'day'}; 
                   1734: 	my $year = $env{'form.' . $var . 'year'}; 
                   1735: 	my $min = 0; 
                   1736: 	my $hour = 0;
                   1737: 	if ($self->{'hoursminutes'}) {
                   1738: 	    $min = $env{'form.' . $var . 'minute'};
                   1739: 	    $hour = $env{'form.' . $var . 'hour'};
                   1740: 	}
                   1741: 
                   1742: 	my $chosenDate;
                   1743: 	eval {$chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);};
                   1744: 	my $error = $@;
                   1745: 
                   1746: 	# Check to make sure that the date was not automatically co-erced into a 
                   1747: 	# valid date, as we want to flag that as an error
                   1748: 	# This happens for "Feb. 31", for instance, which is coerced to March 2 or
                   1749: 	# 3, depending on if it's a leap year
                   1750: 	my $checkDate = localtime($chosenDate);
                   1751: 	
                   1752: 	if ($error || $checkDate->mon != $month || $checkDate->mday != $day ||
                   1753: 	    $checkDate->year + 1900 != $year) {
                   1754: 	    unless (Apache::lonlocal::current_language()== ~/^en/) {
                   1755: 		$self->{ERROR_MSG} = &mt("Invalid date entry");
                   1756: 		return 0;
                   1757: 	    }
                   1758: 	    # LOCALIZATION FIXME: Needs to be parameterized
                   1759: 	    $self->{ERROR_MSG} = "Can't use " . $months[$month] . " $day, $year as a "
                   1760: 		. "date because it doesn't exist. Please enter a valid date.";
1.5       bowersj2 1761: 
1.57      albertel 1762: 	    return 0;
                   1763: 	}
1.118     albertel 1764: 	$helper->{VARS}->{$var} = $chosenDate;
1.5       bowersj2 1765:     }
                   1766: 
1.137     albertel 1767:     if (defined($self->{VALIDATOR})) {
                   1768: 	my $validator = eval($self->{VALIDATOR});
1.138     albertel 1769: 	die 'Died during evaluation of validator code; Perl said: ' . $@ if $@;
1.137     albertel 1770: 	my $invalid = &$validator($helper, $state, $self, $self->getValue());
                   1771: 	if ($invalid) {
                   1772: 	    $self->{ERROR_MSG} = $invalid;
                   1773: 	    return 0;
                   1774: 	}
                   1775:     }
                   1776: 
1.5       bowersj2 1777:     if (defined($self->{NEXTSTATE})) {
                   1778:         $helper->changeState($self->{NEXTSTATE});
                   1779:     }
1.6       bowersj2 1780: 
                   1781:     return 1;
1.5       bowersj2 1782: }
                   1783: 1;
                   1784: 
                   1785: package Apache::lonhelper::resource;
                   1786: 
                   1787: =pod
                   1788: 
1.44      bowersj2 1789: =head2 Element: resourceX<resource, helper element>
1.5       bowersj2 1790: 
                   1791: <resource> elements allow the user to select one or multiple resources
                   1792: from the current course. You can filter out which resources they can view,
                   1793: and filter out which resources they can select. The course will always
                   1794: be displayed fully expanded, because of the difficulty of maintaining
                   1795: selections across folder openings and closings. If this is fixed, then
                   1796: the user can manipulate the folders.
                   1797: 
                   1798: <resource> takes the standard variable attribute to control what helper
1.44      bowersj2 1799: variable stores the results. It also takes a "multichoice"X<multichoice> attribute,
1.17      bowersj2 1800: which controls whether the user can select more then one resource. The 
                   1801: "toponly" attribute controls whether the resource display shows just the
                   1802: resources in that sequence, or recurses into all sub-sequences, defaulting
1.29      bowersj2 1803: to false. The "suppressEmptySequences" attribute reflects the 
                   1804: suppressEmptySequences argument to the render routine, which will cause
                   1805: folders that have all of their contained resources filtered out to also
1.46      bowersj2 1806: be filtered out. The 'addstatus' attribute, if true, will add the icon
1.95      albertel 1807: and long status display columns to the display. The 'addparts'
                   1808: attribute will add in a part selector beside problems that have more
                   1809: than 1 part.
1.5       bowersj2 1810: 
1.44      bowersj2 1811: =head3 SUB-TAGS
1.5       bowersj2 1812: 
                   1813: =over 4
                   1814: 
1.44      bowersj2 1815: =item * <filterfunc>X<filterfunc>: If you want to filter what resources are displayed
1.5       bowersj2 1816:   to the user, use a filter func. The <filterfunc> tag should contain
                   1817:   Perl code that when wrapped with "sub { my $res = shift; " and "}" is 
                   1818:   a function that returns true if the resource should be displayed, 
                   1819:   and false if it should be skipped. $res is a resource object. 
                   1820:   (See Apache::lonnavmaps documentation for information about the 
                   1821:   resource object.)
                   1822: 
1.44      bowersj2 1823: =item * <choicefunc>X<choicefunc>: Same as <filterfunc>, except that controls whether
1.5       bowersj2 1824:   the given resource can be chosen. (It is almost always a good idea to
                   1825:   show the user the folders, for instance, but you do not always want to 
                   1826:   let the user select them.)
                   1827: 
                   1828: =item * <nextstate>: Standard nextstate behavior.
                   1829: 
1.44      bowersj2 1830: =item * <valuefunc>X<valuefunc>: This function controls what is returned by the resource
1.5       bowersj2 1831:   when the user selects it. Like filterfunc and choicefunc, it should be
                   1832:   a function fragment that when wrapped by "sub { my $res = shift; " and
                   1833:   "}" returns a string representing what you want to have as the value. By
                   1834:   default, the value will be the resource ID of the object ($res->{ID}).
                   1835: 
1.44      bowersj2 1836: =item * <mapurl>X<mapurl>: If the URL of a map is given here, only that map
1.48      bowersj2 1837:   will be displayed, instead of the whole course. If the attribute
                   1838:   "evaluate" is given and is true, the contents of the mapurl will be
                   1839:   evaluated with "sub { my $helper = shift; my $state = shift;" and
                   1840:   "}", with the return value used as the mapurl.
1.13      bowersj2 1841: 
1.5       bowersj2 1842: =back
                   1843: 
                   1844: =cut
                   1845: 
                   1846: no strict;
                   1847: @ISA = ("Apache::lonhelper::element");
                   1848: use strict;
1.100     albertel 1849: use Apache::lonnet;
1.5       bowersj2 1850: 
                   1851: BEGIN {
1.7       bowersj2 1852:     &Apache::lonhelper::register('Apache::lonhelper::resource',
1.5       bowersj2 1853:                               ('resource', 'filterfunc', 
1.13      bowersj2 1854:                                'choicefunc', 'valuefunc',
1.90      foxr     1855:                                'mapurl','option'));
1.5       bowersj2 1856: }
                   1857: 
                   1858: sub new {
                   1859:     my $ref = Apache::lonhelper::element->new();
                   1860:     bless($ref);
                   1861: }
                   1862: 
                   1863: # CONSTRUCTION: Construct the message element from the XML
                   1864: sub start_resource {
                   1865:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1866: 
                   1867:     if ($target ne 'helper') {
                   1868:         return '';
                   1869:     }
                   1870: 
                   1871:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   1872:     $helper->declareVar($paramHash->{'variable'});
1.14      bowersj2 1873:     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
1.29      bowersj2 1874:     $paramHash->{'suppressEmptySequences'} = $token->[2]{'suppressEmptySequences'};
1.17      bowersj2 1875:     $paramHash->{'toponly'} = $token->[2]{'toponly'};
1.46      bowersj2 1876:     $paramHash->{'addstatus'} = $token->[2]{'addstatus'};
1.95      albertel 1877:     $paramHash->{'addparts'} = $token->[2]{'addparts'};
                   1878:     if ($paramHash->{'addparts'}) {
                   1879: 	$helper->declareVar($paramHash->{'variable'}.'_part');
                   1880:     }
1.66      albertel 1881:     $paramHash->{'closeallpages'} = $token->[2]{'closeallpages'};
1.5       bowersj2 1882:     return '';
                   1883: }
                   1884: 
                   1885: sub end_resource {
                   1886:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1887: 
                   1888:     if ($target ne 'helper') {
                   1889:         return '';
                   1890:     }
                   1891:     if (!defined($paramHash->{FILTER_FUNC})) {
                   1892:         $paramHash->{FILTER_FUNC} = sub {return 1;};
                   1893:     }
                   1894:     if (!defined($paramHash->{CHOICE_FUNC})) {
                   1895:         $paramHash->{CHOICE_FUNC} = sub {return 1;};
                   1896:     }
                   1897:     if (!defined($paramHash->{VALUE_FUNC})) {
                   1898:         $paramHash->{VALUE_FUNC} = sub {my $res = shift; return $res->{ID}; };
                   1899:     }
                   1900:     Apache::lonhelper::resource->new();
1.4       bowersj2 1901:     return '';
                   1902: }
                   1903: 
1.5       bowersj2 1904: sub start_filterfunc {
                   1905:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1906: 
                   1907:     if ($target ne 'helper') {
                   1908:         return '';
                   1909:     }
                   1910: 
                   1911:     my $contents = Apache::lonxml::get_all_text('/filterfunc',
                   1912:                                                 $parser);
                   1913:     $contents = 'sub { my $res = shift; ' . $contents . '}';
                   1914:     $paramHash->{FILTER_FUNC} = eval $contents;
                   1915: }
                   1916: 
                   1917: sub end_filterfunc { return ''; }
                   1918: 
                   1919: sub start_choicefunc {
                   1920:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1921: 
                   1922:     if ($target ne 'helper') {
                   1923:         return '';
                   1924:     }
                   1925: 
                   1926:     my $contents = Apache::lonxml::get_all_text('/choicefunc',
                   1927:                                                 $parser);
                   1928:     $contents = 'sub { my $res = shift; ' . $contents . '}';
                   1929:     $paramHash->{CHOICE_FUNC} = eval $contents;
                   1930: }
                   1931: 
                   1932: sub end_choicefunc { return ''; }
                   1933: 
                   1934: sub start_valuefunc {
                   1935:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1936: 
                   1937:     if ($target ne 'helper') {
                   1938:         return '';
                   1939:     }
                   1940: 
                   1941:     my $contents = Apache::lonxml::get_all_text('/valuefunc',
                   1942:                                                 $parser);
                   1943:     $contents = 'sub { my $res = shift; ' . $contents . '}';
                   1944:     $paramHash->{VALUE_FUNC} = eval $contents;
                   1945: }
                   1946: 
                   1947: sub end_valuefunc { return ''; }
                   1948: 
1.13      bowersj2 1949: sub start_mapurl {
                   1950:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1951: 
                   1952:     if ($target ne 'helper') {
                   1953:         return '';
                   1954:     }
                   1955: 
                   1956:     my $contents = Apache::lonxml::get_all_text('/mapurl',
                   1957:                                                 $parser);
1.48      bowersj2 1958:     $paramHash->{EVAL_MAP_URL} = $token->[2]{'evaluate'};
1.14      bowersj2 1959:     $paramHash->{MAP_URL} = $contents;
1.13      bowersj2 1960: }
                   1961: 
                   1962: sub end_mapurl { return ''; }
                   1963: 
1.90      foxr     1964: 
                   1965: sub start_option {
                   1966:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1967:     if (!defined($paramHash->{OPTION_TEXTS})) {
                   1968: 	$paramHash->{OPTION_TEXTS} = [ ];
                   1969: 	$paramHash->{OPTION_VARS}  = [ ];
1.91      foxr     1970: 
1.90      foxr     1971:     }
1.91      foxr     1972:     # OPTION_TEXTS is a list of the text attribute
                   1973:     #               values used to create column headings.
                   1974:     # OPTION_VARS is a list of the variable names, used to create the checkbox
                   1975:     #             inputs.
1.90      foxr     1976:     #  We're ok with empty elements. as place holders
                   1977:     # Although the 'variable' element should really exist.
1.91      foxr     1978:     #
                   1979: 
1.90      foxr     1980:     my $option_texts  = $paramHash->{OPTION_TEXTS};
                   1981:     my $option_vars   = $paramHash->{OPTION_VARS};
                   1982:     push(@$option_texts,  $token->[2]{'text'});
                   1983:     push(@$option_vars,   $token->[2]{'variable'});
                   1984: 
1.91      foxr     1985:     #  Need to create and declare the option variables as well to make them
                   1986:     # persistent.
                   1987:     #
                   1988:     my $varname = $token->[2]{'variable'};
                   1989:     $helper->declareVar($varname);
                   1990: 
                   1991: 
1.90      foxr     1992:     return '';
                   1993: }
                   1994: 
                   1995: sub end_option {
                   1996:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   1997:     return '';
                   1998: }
                   1999: 
1.5       bowersj2 2000: # A note, in case I don't get to this before I leave.
                   2001: # If someone complains about the "Back" button returning them
                   2002: # to the previous folder state, instead of returning them to
                   2003: # the previous helper state, the *correct* answer is for the helper
                   2004: # to keep track of how many times the user has manipulated the folders,
                   2005: # and feed that to the history.go() call in the helper rendering routines.
                   2006: # If done correctly, the helper itself can keep track of how many times
                   2007: # it renders the same states, so it doesn't go in just this state, and
                   2008: # you can lean on the browser back button to make sure it all chains
                   2009: # correctly.
                   2010: # Right now, though, I'm just forcing all folders open.
                   2011: 
                   2012: sub render {
                   2013:     my $self = shift;
                   2014:     my $result = "";
                   2015:     my $var = $self->{'variable'};
                   2016:     my $curVal = $helper->{VARS}->{$var};
                   2017: 
1.15      bowersj2 2018:     my $buttons = '';
                   2019: 
                   2020:     if ($self->{'multichoice'}) {
                   2021:         $result = <<SCRIPT;
1.112     albertel 2022: <script type="text/javascript">
                   2023: // <!--
1.18      bowersj2 2024:     function checkall(value, checkName) {
1.15      bowersj2 2025: 	for (i=0; i<document.forms.helpform.elements.length; i++) {
                   2026:             ele = document.forms.helpform.elements[i];
1.18      bowersj2 2027:             if (ele.name == checkName + '.forminput') {
1.15      bowersj2 2028:                 document.forms.helpform.elements[i].checked=value;
                   2029:             }
                   2030:         }
                   2031:     }
1.112     albertel 2032: // -->
1.15      bowersj2 2033: </script>
                   2034: SCRIPT
1.68      sakharuk 2035:         my %lt=&Apache::lonlocal::texthash(
                   2036: 			'sar'  => "Select All Resources",
                   2037: 		        'uar'  => "Unselect All Resources");
                   2038: 
1.15      bowersj2 2039:         $buttons = <<BUTTONS;
                   2040: <br /> &nbsp;
1.68      sakharuk 2041: <input type="button" onclick="checkall(true, '$var')" value="$lt{'sar'}" />
                   2042: <input type="button" onclick="checkall(false, '$var')" value="$lt{'uar'}" />
1.15      bowersj2 2043: <br /> &nbsp;
                   2044: BUTTONS
                   2045:     }
                   2046: 
1.5       bowersj2 2047:     if (defined $self->{ERROR_MSG}) {
1.14      bowersj2 2048:         $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
1.5       bowersj2 2049:     }
                   2050: 
1.15      bowersj2 2051:     $result .= $buttons;
                   2052: 
1.90      foxr     2053:     my $filterFunc     = $self->{FILTER_FUNC};
                   2054:     my $choiceFunc     = $self->{CHOICE_FUNC};
                   2055:     my $valueFunc      = $self->{VALUE_FUNC};
1.95      albertel 2056:     my $multichoice    = $self->{'multichoice'};
1.90      foxr     2057:     my $option_vars    = $self->{OPTION_VARS};
                   2058:     my $option_texts   = $self->{OPTION_TEXTS};
1.95      albertel 2059:     my $addparts       = $self->{'addparts'};
1.90      foxr     2060:     my $headings_done  = 0;
1.5       bowersj2 2061: 
1.48      bowersj2 2062:     # Evaluate the map url as needed
                   2063:     my $mapUrl;
1.49      bowersj2 2064:     if ($self->{EVAL_MAP_URL}) {
1.48      bowersj2 2065: 	my $mapUrlFunc = eval('sub { my $helper = shift; my $state = shift; ' . 
                   2066: 	    $self->{MAP_URL} . '}');
                   2067: 	$mapUrl = &$mapUrlFunc($helper, $self);
                   2068:     } else {
                   2069: 	$mapUrl = $self->{MAP_URL};
                   2070:     }
                   2071: 
1.125     albertel 2072:     my %defaultSymbs;
1.124     albertel 2073:     if (defined($self->{DEFAULT_VALUE})) {
                   2074:         my $valueFunc = eval($self->{DEFAULT_VALUE});
                   2075:         die 'Error in default value code for variable ' . 
                   2076:             $self->{'variable'} . ', Perl said: ' . $@ if $@;
1.125     albertel 2077:         my @defaultSymbs = &$valueFunc($helper, $self);
                   2078: 	if (!$multichoice && @defaultSymbs) { # only allowed 1
1.124     albertel 2079: 	    @defaultSymbs = ($defaultSymbs[0]);
                   2080: 	}
1.125     albertel 2081: 	%defaultSymbs = map { if ($_) {($_,1) } } @defaultSymbs;
                   2082: 	delete($defaultSymbs{''});
1.124     albertel 2083:     }
                   2084: 
1.5       bowersj2 2085:     # Create the composite function that renders the column on the nav map
                   2086:     # have to admit any language that lets me do this can't be all bad
                   2087:     #  - Jeremy (Pythonista) ;-)
                   2088:     my $checked = 0;
                   2089:     my $renderColFunc = sub {
                   2090:         my ($resource, $part, $params) = @_;
1.90      foxr     2091: 	my $result = "";
                   2092: 
                   2093: 	if(!$headings_done) {
                   2094: 	    if ($option_texts) {
                   2095: 		foreach my $text (@$option_texts) {
                   2096: 		    $result .= "<th>$text</th>";
                   2097: 		}
                   2098: 	    }
                   2099: 	    $result .= "<th>Select</th>";
                   2100: 	    $result .= "</tr><tr>"; # Close off the extra row and start a new one.
                   2101: 	    $headings_done = 1;
                   2102: 	}
1.14      bowersj2 2103: 
                   2104:         my $inputType;
                   2105:         if ($multichoice) { $inputType = 'checkbox'; }
                   2106:         else {$inputType = 'radio'; }
                   2107: 
1.5       bowersj2 2108:         if (!&$choiceFunc($resource)) {
1.90      foxr     2109: 	    $result .= '<td>&nbsp;</td>';
                   2110:             return $result;
1.5       bowersj2 2111:         } else {
1.90      foxr     2112: 	    my $col = "";
1.98      foxr     2113: 	    my $raw_name = &$valueFunc($resource);
1.90      foxr     2114: 	    my $resource_name =   
1.98      foxr     2115:                    HTML::Entities::encode($raw_name,"<>&\"'");
1.90      foxr     2116: 	    if($option_vars) {
1.91      foxr     2117: 		foreach my $option_var (@$option_vars) {
1.99      foxr     2118: 		    my $var_value = "\|\|\|" . $helper->{VARS}->{$option_var} . 
                   2119: 			"\|\|\|";
1.98      foxr     2120: 		    my $checked ="";
1.99      foxr     2121: 		    if($var_value =~ /\Q|||$raw_name|||\E/) {
1.111     albertel 2122: 			$checked = "checked='checked'";
1.98      foxr     2123: 		    }
1.90      foxr     2124: 		    $col .= 
1.91      foxr     2125:                         "<td align='center'><input type='checkbox' name ='$option_var".
                   2126: 			".forminput' value='".
1.98      foxr     2127: 			$resource_name . "' $checked /> </td>";
1.90      foxr     2128: 		}
                   2129: 	    }
                   2130: 
                   2131:             $col .= "<td align='center'><input type='$inputType' name='${var}.forminput' ";
1.125     albertel 2132: 	    if (%defaultSymbs) {
1.124     albertel 2133: 		my $symb=$resource->symb();
1.125     albertel 2134: 		if (exists($defaultSymbs{$symb})) {
1.124     albertel 2135: 		    $col .= "checked='checked' ";
                   2136: 		    $checked = 1;
                   2137: 		}
                   2138: 	    } else {
                   2139: 		if (!$checked && !$multichoice) {
                   2140: 		    $col .= "checked='checked' ";
                   2141: 		    $checked = 1;
                   2142: 		}
                   2143: 		if ($multichoice) { # all resources start checked; see bug 1174
                   2144: 		    $col .= "checked='checked' ";
                   2145: 		    $checked = 1;
                   2146: 		}
1.37      bowersj2 2147: 	    }
1.90      foxr     2148:             $col .= "value='" . $resource_name  . "' /></td>";
1.95      albertel 2149: 
1.90      foxr     2150:             return $result.$col;
1.5       bowersj2 2151:         }
                   2152:     };
1.95      albertel 2153:     my $renderPartsFunc = sub {
                   2154:         my ($resource, $part, $params) = @_;
                   2155: 	my $col= "<td>";
                   2156: 	my $id=$resource->{ID};
                   2157: 	my $resource_name =   
                   2158: 	    &HTML::Entities::encode(&$valueFunc($resource),"<>&\"'");
                   2159: 	if ($addparts && (scalar(@{$resource->parts}) > 1)) {
                   2160: 	    $col .= "<select onclick=\"javascript:updateRadio(this.form,'${var}.forminput','$resource_name');updateHidden(this.form,'$id','${var}');\" name='part_$id.forminput'>\n";
                   2161: 	    $col .= "<option value=\"$part\">All Parts</option>\n";
                   2162: 	    foreach my $part (@{$resource->parts}) {
                   2163: 		$col .= "<option value=\"$part\">Part: $part</option>\n";
                   2164: 	    }
                   2165: 	    $col .= "</select>";
                   2166: 	}
                   2167: 	$col .= "</td>";
                   2168:     };
                   2169:     $result.=(<<RADIO);
                   2170: <script type="text/javascript">
1.112     albertel 2171: // <!--
1.95      albertel 2172:     function updateRadio(form,name,value) {
                   2173: 	var radiobutton=form[name];
                   2174: 	for (var i=0; i<radiobutton.length; i++) {
                   2175: 	    if (radiobutton[i].value == value) {
                   2176: 		radiobutton[i].checked = true;
                   2177: 		break;
                   2178: 	    }
                   2179: 	}
                   2180:     }
                   2181:     function updateHidden(form,id,name) {
                   2182: 	var select=form['part_'+id+'.forminput'];
                   2183: 	var hidden=form[name+'_part.forminput'];
                   2184: 	var which=select.selectedIndex;
                   2185: 	hidden.value=select.options[which].value;
                   2186:     }
1.112     albertel 2187: // -->
1.95      albertel 2188: </script>
1.101     albertel 2189: <input type="hidden" name="${var}_part.forminput" />
1.5       bowersj2 2190: 
1.95      albertel 2191: RADIO
1.100     albertel 2192:     $env{'form.condition'} = !$self->{'toponly'};
1.95      albertel 2193:     my $cols = [$renderColFunc];
                   2194:     if ($self->{'addparts'}) { push(@$cols, $renderPartsFunc); }
                   2195:     push(@$cols, Apache::lonnavmaps::resource());
1.46      bowersj2 2196:     if ($self->{'addstatus'}) {
                   2197: 	push @$cols, (Apache::lonnavmaps::part_status_summary());
                   2198: 	
                   2199:     }
1.5       bowersj2 2200:     $result .= 
1.46      bowersj2 2201:         &Apache::lonnavmaps::render( { 'cols' => $cols,
1.5       bowersj2 2202:                                        'showParts' => 0,
                   2203:                                        'filterFunc' => $filterFunc,
1.13      bowersj2 2204:                                        'resource_no_folder_link' => 1,
1.66      albertel 2205: 				       'closeAllPages' => $self->{'closeallpages'},
1.29      bowersj2 2206:                                        'suppressEmptySequences' => $self->{'suppressEmptySequences'},
1.13      bowersj2 2207:                                        'iterator_map' => $mapUrl }
1.5       bowersj2 2208:                                        );
1.15      bowersj2 2209: 
                   2210:     $result .= $buttons;
1.5       bowersj2 2211:                                                 
                   2212:     return $result;
                   2213: }
                   2214:     
                   2215: sub postprocess {
                   2216:     my $self = shift;
1.14      bowersj2 2217: 
                   2218:     if ($self->{'multichoice'} && !$helper->{VARS}->{$self->{'variable'}}) {
                   2219:         $self->{ERROR_MSG} = 'You must choose at least one resource to continue.';
                   2220:         return 0;
                   2221:     }
                   2222: 
1.5       bowersj2 2223:     if (defined($self->{NEXTSTATE})) {
                   2224:         $helper->changeState($self->{NEXTSTATE});
                   2225:     }
1.6       bowersj2 2226: 
                   2227:     return 1;
1.5       bowersj2 2228: }
                   2229: 
                   2230: 1;
                   2231: 
                   2232: package Apache::lonhelper::student;
                   2233: 
                   2234: =pod
                   2235: 
1.44      bowersj2 2236: =head2 Element: studentX<student, helper element>
1.5       bowersj2 2237: 
                   2238: Student elements display a choice of students enrolled in the current
                   2239: course. Currently it is primitive; this is expected to evolve later.
                   2240: 
1.48      bowersj2 2241: Student elements take the following attributes: 
                   2242: 
                   2243: =over 4
                   2244: 
                   2245: =item * B<variable>: 
                   2246: 
                   2247: Does what it usually does: declare which helper variable to put the
                   2248: result in.
                   2249: 
                   2250: =item * B<multichoice>: 
                   2251: 
                   2252: If true allows the user to select multiple students. Defaults to false.
                   2253: 
                   2254: =item * B<coursepersonnel>: 
                   2255: 
                   2256: If true adds the course personnel to the top of the student
                   2257: selection. Defaults to false.
                   2258: 
                   2259: =item * B<activeonly>:
                   2260: 
                   2261: If true, only active students and course personnel will be
                   2262: shown. Defaults to false.
                   2263: 
1.123     albertel 2264: =item * B<emptyallowed>:
                   2265: 
                   2266: If true, the selection of no users is allowed. Defaults to false.
                   2267: 
1.48      bowersj2 2268: =back
1.5       bowersj2 2269: 
                   2270: =cut
                   2271: 
                   2272: no strict;
                   2273: @ISA = ("Apache::lonhelper::element");
                   2274: use strict;
1.59      bowersj2 2275: use Apache::lonlocal;
1.100     albertel 2276: use Apache::lonnet;
1.139     foxr     2277: 
1.5       bowersj2 2278: BEGIN {
1.7       bowersj2 2279:     &Apache::lonhelper::register('Apache::lonhelper::student',
1.5       bowersj2 2280:                               ('student'));
                   2281: }
                   2282: 
                   2283: sub new {
                   2284:     my $ref = Apache::lonhelper::element->new();
                   2285:     bless($ref);
                   2286: }
1.4       bowersj2 2287: 
1.5       bowersj2 2288: sub start_student {
1.4       bowersj2 2289:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2290: 
                   2291:     if ($target ne 'helper') {
                   2292:         return '';
                   2293:     }
                   2294: 
1.5       bowersj2 2295:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   2296:     $helper->declareVar($paramHash->{'variable'});
                   2297:     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
1.39      bowersj2 2298:     $paramHash->{'coursepersonnel'} = $token->[2]{'coursepersonnel'};
1.93      albertel 2299:     $paramHash->{'activeonly'} = $token->[2]{'activeonly'};
1.12      bowersj2 2300:     if (defined($token->[2]{'nextstate'})) {
                   2301:         $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
                   2302:     }
1.123     albertel 2303:     $paramHash->{'emptyallowed'} = $token->[2]{'emptyallowed'};
1.12      bowersj2 2304:     
1.5       bowersj2 2305: }    
                   2306: 
                   2307: sub end_student {
                   2308:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2309: 
                   2310:     if ($target ne 'helper') {
                   2311:         return '';
                   2312:     }
                   2313:     Apache::lonhelper::student->new();
1.3       bowersj2 2314: }
1.5       bowersj2 2315: 
                   2316: sub render {
                   2317:     my $self = shift;
                   2318:     my $result = '';
                   2319:     my $buttons = '';
1.18      bowersj2 2320:     my $var = $self->{'variable'};
1.5       bowersj2 2321: 
                   2322: 
                   2323:     if (defined $self->{ERROR_MSG}) {
                   2324:         $result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
                   2325:     }
                   2326: 
1.126     albertel 2327:     my %defaultUsers;
                   2328:     if (defined($self->{DEFAULT_VALUE})) {
                   2329:         my $valueFunc = eval($self->{DEFAULT_VALUE});
                   2330:         die 'Error in default value code for variable ' . 
                   2331:             $self->{'variable'} . ', Perl said: ' . $@ if $@;
                   2332:         my @defaultUsers = &$valueFunc($helper, $self);
                   2333: 	if (!$self->{'multichoice'} && @defaultUsers) { # only allowed 1
                   2334: 	    @defaultUsers = ($defaultUsers[0]);
                   2335: 	}
                   2336: 	%defaultUsers = map { if ($_) {($_,1) } } @defaultUsers;
                   2337: 	delete($defaultUsers{''});
                   2338:     }
1.139     foxr     2339: 
                   2340: 
1.147     foxr     2341:     my ($course_personnel, 
                   2342: 	$current_members, 
                   2343: 	$expired_members, 
1.148   ! foxr     2344: 	$future_members) = &Apache::lonselstudent::get_people_in_class();
1.139     foxr     2345: 
                   2346: 
1.39      bowersj2 2347: 
                   2348:     # Load up the non-students, if necessary
1.147     foxr     2349: 
1.39      bowersj2 2350:     if ($self->{'coursepersonnel'}) {
1.147     foxr     2351: 	unshift @$current_members, (@$course_personnel);
1.39      bowersj2 2352:     }
1.5       bowersj2 2353: 
                   2354: 
1.139     foxr     2355:     #   Current personel
                   2356: 
1.148   ! foxr     2357:     $result .= &Apache::lonselstudent::render_student_list( $current_members,
1.146     foxr     2358: 				     "current",
                   2359: 				     \%defaultUsers,
                   2360: 				     $self->{'multichoice'},
                   2361: 				     $self->{'variable'},
                   2362: 				     1);
1.139     foxr     2363: 
1.132     foxr     2364: 
1.139     foxr     2365:     # If activeonly is not set then we can also give the expired students:
                   2366:     #
                   2367:     if (!$self->{'activeonly'} && ((scalar @$expired_members) > 0)) {
1.132     foxr     2368: 
1.140     albertel 2369: 	# And future.
                   2370: 
1.148   ! foxr     2371: 	$result .= &Apache::lonselstudent::render_student_list( $future_members,
1.146     foxr     2372: 					 "future",
                   2373: 					 \%defaultUsers,
                   2374: 					 $self->{'multichoice'},
                   2375: 					 $self->{'variable'},
                   2376: 					 0);
1.139     foxr     2377: 	# Past 
1.39      bowersj2 2378: 
1.148   ! foxr     2379: 	$result .= &Apache::lonselstudent::render_student_list($expired_members,
1.146     foxr     2380: 					"past",
                   2381: 					\%defaultUsers,
1.144     foxr     2382: 					$self->{'multichoice'},
1.145     foxr     2383: 					$self->{'variable'},
                   2384: 					0);
1.132     foxr     2385:     }
1.5       bowersj2 2386: 
1.113     foxr     2387: 
                   2388: 
1.5       bowersj2 2389:     return $result;
                   2390: }
                   2391: 
1.6       bowersj2 2392: sub postprocess {
                   2393:     my $self = shift;
                   2394: 
1.100     albertel 2395:     my $result = $env{'form.' . $self->{'variable'} . '.forminput'};
1.123     albertel 2396:     if (!$result && !$self->{'emptyallowed'}) {
                   2397: 	if ($self->{'coursepersonnel'}) {
                   2398: 	    $self->{ERROR_MSG} = 
                   2399: 		&mt('You must choose at least one user to continue.');
                   2400: 	} else {
                   2401: 	    $self->{ERROR_MSG} = 
                   2402: 		&mt('You must choose at least one student to continue.');
                   2403: 	}
1.6       bowersj2 2404:         return 0;
                   2405:     }
                   2406: 
                   2407:     if (defined($self->{NEXTSTATE})) {
                   2408:         $helper->changeState($self->{NEXTSTATE});
                   2409:     }
                   2410: 
                   2411:     return 1;
                   2412: }
                   2413: 
1.5       bowersj2 2414: 1;
                   2415: 
                   2416: package Apache::lonhelper::files;
                   2417: 
                   2418: =pod
                   2419: 
1.44      bowersj2 2420: =head2 Element: filesX<files, helper element>
1.5       bowersj2 2421: 
                   2422: files allows the users to choose files from a given directory on the
                   2423: server. It is always multichoice and stores the result as a triple-pipe
                   2424: delimited entry in the helper variables. 
                   2425: 
                   2426: Since it is extremely unlikely that you can actually code a constant
                   2427: representing the directory you wish to allow the user to search, <files>
                   2428: takes a subroutine that returns the name of the directory you wish to
                   2429: have the user browse.
                   2430: 
                   2431: files accepts the attribute "variable" to control where the files chosen
                   2432: are put. It accepts the attribute "multichoice" as the other attribute,
                   2433: defaulting to false, which if true will allow the user to select more
                   2434: then one choice. 
                   2435: 
1.44      bowersj2 2436: <files> accepts three subtags: 
                   2437: 
                   2438: =over 4
                   2439: 
                   2440: =item * B<nextstate>: works as it does with the other tags. 
                   2441: 
                   2442: =item * B<filechoice>: When the contents of this tag are surrounded by
                   2443:     "sub {" and "}", will return a string representing what directory
                   2444:     on the server to allow the user to choose files from. 
                   2445: 
                   2446: =item * B<filefilter>: Should contain Perl code that when surrounded
                   2447:     by "sub { my $filename = shift; " and "}", returns a true value if
                   2448:     the user can pick that file, or false otherwise. The filename
                   2449:     passed to the function will be just the name of the file, with no
                   2450:     path info. By default, a filter function will be used that will
                   2451:     mask out old versions of files. This function is available as
                   2452:     Apache::lonhelper::files::not_old_version if you want to use it to
                   2453:     composite your own filters.
                   2454: 
                   2455: =back
                   2456: 
                   2457: B<General security note>: You should ensure the user can not somehow 
                   2458: pass something into your code that would allow them to look places 
                   2459: they should not be able to see, like the C</etc/> directory. However,
                   2460: the security impact would be minimal, since it would only expose
                   2461: the existence of files, there should be no way to parlay that into
                   2462: viewing the files. 
1.5       bowersj2 2463: 
                   2464: =cut
                   2465: 
                   2466: no strict;
                   2467: @ISA = ("Apache::lonhelper::element");
                   2468: use strict;
1.59      bowersj2 2469: use Apache::lonlocal;
1.100     albertel 2470: use Apache::lonnet;
1.32      bowersj2 2471: use Apache::lonpubdir; # for getTitleString
                   2472: 
1.5       bowersj2 2473: BEGIN {
1.7       bowersj2 2474:     &Apache::lonhelper::register('Apache::lonhelper::files',
                   2475:                                  ('files', 'filechoice', 'filefilter'));
1.5       bowersj2 2476: }
                   2477: 
1.44      bowersj2 2478: sub not_old_version {
                   2479:     my $file = shift;
                   2480:     
                   2481:     # Given a file name, return false if it is an "old version" of a
                   2482:     # file, or true if it is not.
                   2483: 
                   2484:     if ($file =~ /^.*\.[0-9]+\.[A-Za-z]+(\.meta)?$/) {
                   2485: 	return 0;
                   2486:     }
                   2487:     return 1;
                   2488: }
                   2489: 
1.5       bowersj2 2490: sub new {
                   2491:     my $ref = Apache::lonhelper::element->new();
                   2492:     bless($ref);
                   2493: }
                   2494: 
                   2495: sub start_files {
                   2496:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2497: 
                   2498:     if ($target ne 'helper') {
                   2499:         return '';
                   2500:     }
                   2501:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   2502:     $helper->declareVar($paramHash->{'variable'});
                   2503:     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
                   2504: }    
                   2505: 
                   2506: sub end_files {
                   2507:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2508: 
                   2509:     if ($target ne 'helper') {
                   2510:         return '';
                   2511:     }
                   2512:     if (!defined($paramHash->{FILTER_FUNC})) {
                   2513:         $paramHash->{FILTER_FUNC} = sub { return 1; };
                   2514:     }
                   2515:     Apache::lonhelper::files->new();
                   2516: }    
                   2517: 
                   2518: sub start_filechoice {
                   2519:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2520: 
                   2521:     if ($target ne 'helper') {
                   2522:         return '';
                   2523:     }
                   2524:     $paramHash->{'filechoice'} = Apache::lonxml::get_all_text('/filechoice',
                   2525:                                                               $parser);
                   2526: }
                   2527: 
                   2528: sub end_filechoice { return ''; }
                   2529: 
                   2530: sub start_filefilter {
                   2531:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2532: 
                   2533:     if ($target ne 'helper') {
                   2534:         return '';
                   2535:     }
                   2536: 
                   2537:     my $contents = Apache::lonxml::get_all_text('/filefilter',
                   2538:                                                 $parser);
                   2539:     $contents = 'sub { my $filename = shift; ' . $contents . '}';
                   2540:     $paramHash->{FILTER_FUNC} = eval $contents;
                   2541: }
                   2542: 
                   2543: sub end_filefilter { return ''; }
1.3       bowersj2 2544: 
1.87      matthew  2545: { 
                   2546:     # used to generate unique id attributes for <input> tags. 
                   2547:     # internal use only.
                   2548:     my $id=0;
                   2549:     sub new_id { return $id++;}
                   2550: }
                   2551: 
1.3       bowersj2 2552: sub render {
                   2553:     my $self = shift;
1.5       bowersj2 2554:     my $result = '';
                   2555:     my $var = $self->{'variable'};
                   2556:     
                   2557:     my $subdirFunc = eval('sub {' . $self->{'filechoice'} . '}');
1.11      bowersj2 2558:     die 'Error in resource filter code for variable ' . 
                   2559:         {'variable'} . ', Perl said:' . $@ if $@;
                   2560: 
1.5       bowersj2 2561:     my $subdir = &$subdirFunc();
                   2562: 
                   2563:     my $filterFunc = $self->{FILTER_FUNC};
1.44      bowersj2 2564:     if (!defined($filterFunc)) {
                   2565: 	$filterFunc = &not_old_version;
                   2566:     }
1.5       bowersj2 2567:     my $buttons = '';
1.22      bowersj2 2568:     my $type = 'radio';
                   2569:     if ($self->{'multichoice'}) {
                   2570:         $type = 'checkbox';
                   2571:     }
1.5       bowersj2 2572: 
                   2573:     if ($self->{'multichoice'}) {
                   2574:         $result = <<SCRIPT;
1.112     albertel 2575: <script type="text/javascript">
                   2576: // <!--
1.18      bowersj2 2577:     function checkall(value, checkName) {
1.15      bowersj2 2578: 	for (i=0; i<document.forms.helpform.elements.length; i++) {
                   2579:             ele = document.forms.helpform.elements[i];
1.18      bowersj2 2580:             if (ele.name == checkName + '.forminput') {
1.15      bowersj2 2581:                 document.forms.helpform.elements[i].checked=value;
1.5       bowersj2 2582:             }
                   2583:         }
                   2584:     }
1.21      bowersj2 2585: 
1.22      bowersj2 2586:     function checkallclass(value, className) {
1.21      bowersj2 2587:         for (i=0; i<document.forms.helpform.elements.length; i++) {
                   2588:             ele = document.forms.helpform.elements[i];
1.22      bowersj2 2589:             if (ele.type == "$type" && ele.onclick) {
1.21      bowersj2 2590:                 document.forms.helpform.elements[i].checked=value;
                   2591:             }
                   2592:         }
                   2593:     }
1.112     albertel 2594: // -->
1.5       bowersj2 2595: </script>
                   2596: SCRIPT
1.68      sakharuk 2597:        my %lt=&Apache::lonlocal::texthash(
                   2598: 			'saf'  => "Select All Files",
                   2599: 		        'uaf'  => "Unselect All Files");
                   2600:        $buttons = <<BUTTONS;
1.5       bowersj2 2601: <br /> &nbsp;
1.68      sakharuk 2602: <input type="button" onclick="checkall(true, '$var')" value="$lt{'saf'}" />
                   2603: <input type="button" onclick="checkall(false, '$var')" value="$lt{'uaf'}" />
1.23      bowersj2 2604: BUTTONS
                   2605: 
1.69      sakharuk 2606:        %lt=&Apache::lonlocal::texthash(
1.68      sakharuk 2607: 			'sap'  => "Select All Published",
                   2608: 		        'uap'  => "Unselect All Published");
1.23      bowersj2 2609:         if ($helper->{VARS}->{'construction'}) {
1.68      sakharuk 2610:        $buttons .= <<BUTTONS;
                   2611: <input type="button" onclick="checkallclass(true, 'Published')" value="$lt{'sap'}" />
                   2612: <input type="button" onclick="checkallclass(false, 'Published')" value="$lt{'uap'}" />
1.5       bowersj2 2613: <br /> &nbsp;
                   2614: BUTTONS
1.23      bowersj2 2615:        }
1.5       bowersj2 2616:     }
                   2617: 
                   2618:     # Get the list of files in this directory.
                   2619:     my @fileList;
                   2620: 
                   2621:     # If the subdirectory is in local CSTR space
1.47      albertel 2622:     my $metadir;
                   2623:     if ($subdir =~ m|/home/([^/]+)/public_html/(.*)|) {
1.110     albertel 2624: 	my ($user,$domain)= 
                   2625: 	    &Apache::loncacc::constructaccess($subdir,
                   2626: 				     $Apache::lonnet::perlvar{'lonDefDomain'});
1.47      albertel 2627: 	$metadir='/res/'.$domain.'/'.$user.'/'.$2;
                   2628:         @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
                   2629:     } elsif ($subdir =~ m|^~([^/]+)/(.*)$|) {
                   2630: 	$subdir='/home/'.$1.'/public_html/'.$2;
1.110     albertel 2631: 	my ($user,$domain)= 
                   2632: 	    &Apache::loncacc::constructaccess($subdir,
                   2633: 				     $Apache::lonnet::perlvar{'lonDefDomain'});
1.47      albertel 2634: 	$metadir='/res/'.$domain.'/'.$user.'/'.$2;
1.5       bowersj2 2635:         @fileList = &Apache::lonnet::dirlist($subdir, $domain, $user, '');
                   2636:     } else {
                   2637:         # local library server resource space
1.100     albertel 2638:         @fileList = &Apache::lonnet::dirlist($subdir, $env{'user.domain'}, $env{'user.name'}, '');
1.5       bowersj2 2639:     }
1.3       bowersj2 2640: 
1.44      bowersj2 2641:     # Sort the fileList into order
1.85      albertel 2642:     @fileList = sort {lc($a) cmp lc($b)} @fileList;
1.44      bowersj2 2643: 
1.5       bowersj2 2644:     $result .= $buttons;
                   2645: 
1.6       bowersj2 2646:     if (defined $self->{ERROR_MSG}) {
                   2647:         $result .= '<br /><font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
                   2648:     }
                   2649: 
1.20      bowersj2 2650:     $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1.5       bowersj2 2651: 
                   2652:     # Keeps track if there are no choices, prints appropriate error
                   2653:     # if there are none. 
                   2654:     my $choices = 0;
                   2655:     # Print each legitimate file choice.
                   2656:     for my $file (@fileList) {
                   2657:         $file = (split(/&/, $file))[0];
                   2658:         if ($file eq '.' || $file eq '..') {
                   2659:             next;
                   2660:         }
                   2661:         my $fileName = $subdir .'/'. $file;
                   2662:         if (&$filterFunc($file)) {
1.24      sakharuk 2663: 	    my $status;
                   2664: 	    my $color;
                   2665: 	    if ($helper->{VARS}->{'construction'}) {
                   2666: 		($status, $color) = @{fileState($subdir, $file)};
                   2667: 	    } else {
                   2668: 		$status = '';
                   2669: 		$color = '';
                   2670: 	    }
1.22      bowersj2 2671: 
1.32      bowersj2 2672:             # Get the title
1.47      albertel 2673:             my $title = Apache::lonpubdir::getTitleString(($metadir?$metadir:$subdir) .'/'. $file);
1.32      bowersj2 2674: 
1.22      bowersj2 2675:             # Netscape 4 is stupid and there's nowhere to put the
                   2676:             # information on the input tag that the file is Published,
                   2677:             # Unpublished, etc. In *real* browsers we can just say
                   2678:             # "class='Published'" and check the className attribute of
                   2679:             # the input tag, but Netscape 4 is too stupid to understand
                   2680:             # that attribute, and un-comprehended attributes are not
                   2681:             # reflected into the object model. So instead, what I do 
                   2682:             # is either have or don't have an "onclick" handler that 
                   2683:             # does nothing, give Published files the onclick handler, and
                   2684:             # have the checker scripts check for that. Stupid and clumsy,
                   2685:             # and only gives us binary "yes/no" information (at least I
                   2686:             # couldn't figure out how to reach into the event handler's
                   2687:             # actual code to retreive a value), but it works well enough
                   2688:             # here.
1.23      bowersj2 2689:         
1.22      bowersj2 2690:             my $onclick = '';
1.23      bowersj2 2691:             if ($status eq 'Published' && $helper->{VARS}->{'construction'}) {
1.22      bowersj2 2692:                 $onclick = 'onclick="a=1" ';
                   2693:             }
1.87      matthew  2694:             my $id = &new_id();
1.20      bowersj2 2695:             $result .= '<tr><td align="right"' . " bgcolor='$color'>" .
1.22      bowersj2 2696:                 "<input $onclick type='$type' name='" . $var
1.89      foxr     2697:             . ".forminput' ".qq{id="$id"}." value='" . HTML::Entities::encode($fileName,"<>&\"'").
1.5       bowersj2 2698:                 "'";
                   2699:             if (!$self->{'multichoice'} && $choices == 0) {
1.111     albertel 2700:                 $result .= ' checked="checked"';
1.5       bowersj2 2701:             }
1.87      matthew  2702:             $result .= "/></td><td bgcolor='$color'>".
                   2703:                 qq{<label for="$id">}. $file . "</label></td>" .
1.32      bowersj2 2704:                 "<td bgcolor='$color'>$title</td>" .
                   2705:                 "<td bgcolor='$color'>$status</td>" . "</tr>\n";
1.5       bowersj2 2706:             $choices++;
                   2707:         }
                   2708:     }
                   2709: 
                   2710:     $result .= "</table>\n";
                   2711: 
                   2712:     if (!$choices) {
1.47      albertel 2713:         $result .= '<font color="#FF0000">There are no files available to select in this directory ('.$subdir.'). Please go back and select another option.</font><br /><br />';
1.5       bowersj2 2714:     }
                   2715: 
                   2716:     $result .= $buttons;
                   2717: 
                   2718:     return $result;
1.20      bowersj2 2719: }
                   2720: 
                   2721: # Determine the state of the file: Published, unpublished, modified.
                   2722: # Return the color it should be in and a label as a two-element array
                   2723: # reference.
                   2724: # Logic lifted from lonpubdir.pm, even though I don't know that it's still
                   2725: # the most right thing to do.
                   2726: 
                   2727: sub fileState {
                   2728:     my $constructionSpaceDir = shift;
                   2729:     my $file = shift;
                   2730:     
1.100     albertel 2731:     my ($uname,$udom)=($env{'user.name'},$env{'user.domain'});
                   2732:     if ($env{'request.role'}=~/^ca\./) {
                   2733: 	(undef,$udom,$uname)=split(/\//,$env{'request.role'});
1.86      albertel 2734:     }
1.20      bowersj2 2735:     my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
                   2736:     my $subdirpart = $constructionSpaceDir;
1.86      albertel 2737:     $subdirpart =~ s/^\/home\/$uname\/public_html//;
                   2738:     my $resdir = $docroot . '/res/' . $udom . '/' . $uname .
1.20      bowersj2 2739:         $subdirpart;
                   2740: 
                   2741:     my @constructionSpaceFileStat = stat($constructionSpaceDir . '/' . $file);
                   2742:     my @resourceSpaceFileStat = stat($resdir . '/' . $file);
                   2743:     if (!@resourceSpaceFileStat) {
                   2744:         return ['Unpublished', '#FFCCCC'];
                   2745:     }
                   2746: 
                   2747:     my $constructionSpaceFileModified = $constructionSpaceFileStat[9];
                   2748:     my $resourceSpaceFileModified = $resourceSpaceFileStat[9];
                   2749:     
                   2750:     if ($constructionSpaceFileModified > $resourceSpaceFileModified) {
                   2751:         return ['Modified', '#FFFFCC'];
                   2752:     }
                   2753:     return ['Published', '#CCFFCC'];
1.4       bowersj2 2754: }
1.5       bowersj2 2755: 
1.4       bowersj2 2756: sub postprocess {
                   2757:     my $self = shift;
1.100     albertel 2758:     my $result = $env{'form.' . $self->{'variable'} . '.forminput'};
1.6       bowersj2 2759:     if (!$result) {
                   2760:         $self->{ERROR_MSG} = 'You must choose at least one file '.
                   2761:             'to continue.';
                   2762:         return 0;
                   2763:     }
                   2764: 
1.5       bowersj2 2765:     if (defined($self->{NEXTSTATE})) {
                   2766:         $helper->changeState($self->{NEXTSTATE});
1.3       bowersj2 2767:     }
1.6       bowersj2 2768: 
                   2769:     return 1;
1.3       bowersj2 2770: }
1.8       bowersj2 2771: 
                   2772: 1;
                   2773: 
1.11      bowersj2 2774: package Apache::lonhelper::section;
                   2775: 
                   2776: =pod
                   2777: 
1.44      bowersj2 2778: =head2 Element: sectionX<section, helper element>
1.11      bowersj2 2779: 
                   2780: <section> allows the user to choose one or more sections from the current
                   2781: course.
                   2782: 
1.134     albertel 2783: It takes the standard attributes "variable", "multichoice",
                   2784: "allowempty" and "nextstate", meaning what they do for most other
                   2785: elements.
                   2786: 
                   2787: also takes a boolean 'onlysections' whcih will restrict this to only
                   2788: have sections and not include groups
1.11      bowersj2 2789: 
                   2790: =cut
                   2791: 
                   2792: no strict;
                   2793: @ISA = ("Apache::lonhelper::choices");
                   2794: use strict;
                   2795: 
                   2796: BEGIN {
                   2797:     &Apache::lonhelper::register('Apache::lonhelper::section',
                   2798:                                  ('section'));
                   2799: }
                   2800: 
                   2801: sub new {
                   2802:     my $ref = Apache::lonhelper::choices->new();
                   2803:     bless($ref);
                   2804: }
                   2805: 
                   2806: sub start_section {
                   2807:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2808: 
                   2809:     if ($target ne 'helper') {
                   2810:         return '';
                   2811:     }
1.12      bowersj2 2812: 
                   2813:     $paramHash->{CHOICES} = [];
                   2814: 
1.11      bowersj2 2815:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   2816:     $helper->declareVar($paramHash->{'variable'});
                   2817:     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
1.133     albertel 2818:     $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
1.11      bowersj2 2819:     if (defined($token->[2]{'nextstate'})) {
1.12      bowersj2 2820:         $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
1.11      bowersj2 2821:     }
                   2822: 
                   2823:     # Populate the CHOICES element
                   2824:     my %choices;
                   2825: 
                   2826:     my $section = Apache::loncoursedata::CL_SECTION();
                   2827:     my $classlist = Apache::loncoursedata::get_classlist();
1.143     albertel 2828:     foreach my $user (keys(%$classlist)) {
                   2829:         my $section_name = $classlist->{$user}[$section];
                   2830:         if (!$section_name) {
1.11      bowersj2 2831:             $choices{"No section assigned"} = "";
                   2832:         } else {
1.143     albertel 2833:             $choices{$section_name} = $section_name;
1.11      bowersj2 2834:         }
1.12      bowersj2 2835:     } 
                   2836:    
1.143     albertel 2837:     if (exists($choices{"No section assigned"})) {
                   2838: 	push(@{$paramHash->{CHOICES}}, 
                   2839: 	     ['No section assigned','No section assigned']);
                   2840: 	delete($choices{"No section assigned"});
                   2841:     }
                   2842:     for my $section_name (sort {lc($a) cmp lc($b) } (keys(%choices))) {
                   2843: 	push @{$paramHash->{CHOICES}}, [$section_name, $section_name];
1.134     albertel 2844:     }
                   2845:     return if ($token->[2]{'onlysections'});
                   2846: 
                   2847:     # add in groups to the end of the list
1.142     albertel 2848:     my %curr_groups = &Apache::loncommon::coursegroups();
                   2849:     foreach my $group_name (sort(keys(%curr_groups))) {
                   2850: 	push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
1.11      bowersj2 2851:     }
                   2852: }    
                   2853: 
1.12      bowersj2 2854: sub end_section {
                   2855:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.11      bowersj2 2856: 
1.12      bowersj2 2857:     if ($target ne 'helper') {
                   2858:         return '';
                   2859:     }
                   2860:     Apache::lonhelper::section->new();
                   2861: }    
1.11      bowersj2 2862: 1;
                   2863: 
1.128     raeburn  2864: package Apache::lonhelper::group;
                   2865: 
                   2866: =pod
                   2867:  
                   2868: =head2 Element: groupX<group, helper element>
                   2869:  
1.134     albertel 2870: <group> allows the user to choose one or more groups from the current course.
                   2871: 
                   2872: It takes the standard attributes "variable", "multichoice",
                   2873:  "allowempty" and "nextstate", meaning what they do for most other
                   2874:  elements.
1.128     raeburn  2875: 
                   2876: =cut
                   2877: 
                   2878: no strict;
                   2879: @ISA = ("Apache::lonhelper::choices");
                   2880: use strict;
                   2881: 
                   2882: BEGIN {
                   2883:     &Apache::lonhelper::register('Apache::lonhelper::group',
                   2884:                                  ('group'));
                   2885: }
                   2886: 
                   2887: sub new {
                   2888:     my $ref = Apache::lonhelper::choices->new();
                   2889:     bless($ref);
                   2890: }
                   2891:  
                   2892: sub start_group {
                   2893:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2894:  
                   2895:     if ($target ne 'helper') {
                   2896:         return '';
                   2897:     }
                   2898: 
                   2899:     $paramHash->{CHOICES} = [];
                   2900: 
                   2901:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   2902:     $helper->declareVar($paramHash->{'variable'});
                   2903:     $paramHash->{'multichoice'} = $token->[2]{'multichoice'};
1.133     albertel 2904:     $paramHash->{'allowempty'} = $token->[2]{'allowempty'};
1.128     raeburn  2905:     if (defined($token->[2]{'nextstate'})) {
                   2906:         $paramHash->{NEXTSTATE} = $token->[2]{'nextstate'};
                   2907:     }
                   2908: 
                   2909:     # Populate the CHOICES element
                   2910:     my %choices;
                   2911: 
1.142     albertel 2912:     my %curr_groups = &Apache::loncommon::coursegroups();
1.143     albertel 2913:     foreach my $group_name (sort {lc($a) cmp lc($b)} (keys(%curr_groups))) {
1.142     albertel 2914: 	push(@{$paramHash->{CHOICES}}, [$group_name, $group_name]);
1.128     raeburn  2915:     }
                   2916: }
1.134     albertel 2917: 
1.128     raeburn  2918: sub end_group {
                   2919:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2920: 
                   2921:     if ($target ne 'helper') {
                   2922:         return '';
                   2923:     }
                   2924:     Apache::lonhelper::group->new();
                   2925: }
                   2926: 1;
                   2927: 
1.34      bowersj2 2928: package Apache::lonhelper::string;
                   2929: 
                   2930: =pod
                   2931: 
1.44      bowersj2 2932: =head2 Element: stringX<string, helper element>
1.34      bowersj2 2933: 
                   2934: string elements provide a string entry field for the user. string elements
                   2935: take the usual 'variable' and 'nextstate' parameters. string elements
                   2936: also pass through 'maxlength' and 'size' attributes to the input tag.
                   2937: 
                   2938: string honors the defaultvalue tag, if given.
                   2939: 
1.38      bowersj2 2940: string honors the validation function, if given.
                   2941: 
1.34      bowersj2 2942: =cut
                   2943: 
                   2944: no strict;
                   2945: @ISA = ("Apache::lonhelper::element");
                   2946: use strict;
1.76      sakharuk 2947: use Apache::lonlocal;
1.34      bowersj2 2948: 
                   2949: BEGIN {
                   2950:     &Apache::lonhelper::register('Apache::lonhelper::string',
                   2951:                               ('string'));
                   2952: }
                   2953: 
                   2954: sub new {
                   2955:     my $ref = Apache::lonhelper::element->new();
                   2956:     bless($ref);
                   2957: }
                   2958: 
                   2959: # CONSTRUCTION: Construct the message element from the XML
                   2960: sub start_string {
                   2961:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2962: 
                   2963:     if ($target ne 'helper') {
                   2964:         return '';
                   2965:     }
                   2966: 
                   2967:     $paramHash->{'variable'} = $token->[2]{'variable'};
                   2968:     $helper->declareVar($paramHash->{'variable'});
                   2969:     $paramHash->{'nextstate'} = $token->[2]{'nextstate'};
                   2970:     $paramHash->{'maxlength'} = $token->[2]{'maxlength'};
                   2971:     $paramHash->{'size'} = $token->[2]{'size'};
                   2972: 
                   2973:     return '';
                   2974: }
                   2975: 
                   2976: sub end_string {
                   2977:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   2978: 
                   2979:     if ($target ne 'helper') {
                   2980:         return '';
                   2981:     }
                   2982:     Apache::lonhelper::string->new();
                   2983:     return '';
                   2984: }
                   2985: 
                   2986: sub render {
                   2987:     my $self = shift;
1.38      bowersj2 2988:     my $result = '';
                   2989: 
                   2990:     if (defined $self->{ERROR_MSG}) {
1.97      albertel 2991:         $result .= '<p><font color="#FF0000">' . $self->{ERROR_MSG} . '</font></p>';
1.38      bowersj2 2992:     }
                   2993: 
                   2994:     $result .= '<input type="string" name="' . $self->{'variable'} . '.forminput"';
1.34      bowersj2 2995: 
                   2996:     if (defined($self->{'size'})) {
                   2997:         $result .= ' size="' . $self->{'size'} . '"';
                   2998:     }
                   2999:     if (defined($self->{'maxlength'})) {
                   3000:         $result .= ' maxlength="' . $self->{'maxlength'} . '"';
                   3001:     }
                   3002: 
                   3003:     if (defined($self->{DEFAULT_VALUE})) {
                   3004:         my $valueFunc = eval($self->{DEFAULT_VALUE});
                   3005:         die 'Error in default value code for variable ' . 
                   3006:             $self->{'variable'} . ', Perl said: ' . $@ if $@;
                   3007:         $result .= ' value="' . &$valueFunc($helper, $self) . '"';
                   3008:     }
                   3009: 
                   3010:     $result .= ' />';
                   3011: 
                   3012:     return $result;
                   3013: }
                   3014: 
                   3015: # If a NEXTSTATE was given, switch to it
                   3016: sub postprocess {
                   3017:     my $self = shift;
1.38      bowersj2 3018: 
                   3019:     if (defined($self->{VALIDATOR})) {
                   3020: 	my $validator = eval($self->{VALIDATOR});
1.138     albertel 3021: 	die 'Died during evaluation of validator code; Perl said: ' . $@ if $@;
1.38      bowersj2 3022: 	my $invalid = &$validator($helper, $state, $self, $self->getValue());
                   3023: 	if ($invalid) {
                   3024: 	    $self->{ERROR_MSG} = $invalid;
                   3025: 	    return 0;
                   3026: 	}
                   3027:     }
                   3028: 
                   3029:     if (defined($self->{'nextstate'})) {
                   3030:         $helper->changeState($self->{'nextstate'});
1.34      bowersj2 3031:     }
                   3032: 
                   3033:     return 1;
                   3034: }
                   3035: 
                   3036: 1;
                   3037: 
1.8       bowersj2 3038: package Apache::lonhelper::general;
                   3039: 
                   3040: =pod
                   3041: 
1.44      bowersj2 3042: =head2 General-purpose tag: <exec>X<exec, helper tag>
1.8       bowersj2 3043: 
1.44      bowersj2 3044: The contents of the exec tag are executed as Perl code, B<not> inside a 
1.100     albertel 3045: safe space, so the full range of $env and such is available. The code
1.8       bowersj2 3046: will be executed as a subroutine wrapped with the following code:
                   3047: 
                   3048: "sub { my $helper = shift; my $state = shift;" and
                   3049: 
                   3050: "}"
                   3051: 
                   3052: The return value is ignored.
                   3053: 
                   3054: $helper is the helper object. Feel free to add methods to the helper
                   3055: object to support whatever manipulation you may need to do (for instance,
                   3056: overriding the form location if the state is the final state; see 
1.44      bowersj2 3057: parameter.helper for an example).
1.8       bowersj2 3058: 
                   3059: $state is the $paramHash that has currently been generated and may
                   3060: be manipulated by the code in exec. Note that the $state is not yet
                   3061: an actual state B<object>, it is just a hash, so do not expect to
                   3062: be able to call methods on it.
                   3063: 
                   3064: =cut
                   3065: 
1.83      sakharuk 3066: use Apache::lonlocal;
1.102     albertel 3067: use Apache::lonnet;
1.83      sakharuk 3068: 
1.8       bowersj2 3069: BEGIN {
                   3070:     &Apache::lonhelper::register('Apache::lonhelper::general',
1.11      bowersj2 3071:                                  'exec', 'condition', 'clause',
                   3072:                                  'eval');
1.8       bowersj2 3073: }
                   3074: 
                   3075: sub start_exec {
                   3076:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3077: 
                   3078:     if ($target ne 'helper') {
                   3079:         return '';
                   3080:     }
                   3081:     
                   3082:     my $code = &Apache::lonxml::get_all_text('/exec', $parser);
                   3083:     
                   3084:     $code = eval ('sub { my $helper = shift; my $state = shift; ' .
                   3085:         $code . "}");
1.11      bowersj2 3086:     die 'Error in <exec>, Perl said: '. $@ if $@;
1.8       bowersj2 3087:     &$code($helper, $paramHash);
                   3088: }
                   3089: 
                   3090: sub end_exec { return ''; }
                   3091: 
                   3092: =pod
                   3093: 
                   3094: =head2 General-purpose tag: <condition>
                   3095: 
                   3096: The <condition> tag allows you to mask out parts of the helper code
                   3097: depending on some programatically determined condition. The condition
                   3098: tag contains a tag <clause> which contains perl code that when wrapped
                   3099: with "sub { my $helper = shift; my $state = shift; " and "}", returns
                   3100: a true value if the XML in the condition should be evaluated as a normal
                   3101: part of the helper, or false if it should be completely discarded.
                   3102: 
                   3103: The <clause> tag must be the first sub-tag of the <condition> tag or
                   3104: it will not work as expected.
                   3105: 
                   3106: =cut
                   3107: 
                   3108: # The condition tag just functions as a marker, it doesn't have
                   3109: # to "do" anything. Technically it doesn't even have to be registered
                   3110: # with the lonxml code, but I leave this here to be explicit about it.
                   3111: sub start_condition { return ''; }
                   3112: sub end_condition { return ''; }
                   3113: 
                   3114: sub start_clause {
                   3115:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3116: 
                   3117:     if ($target ne 'helper') {
                   3118:         return '';
                   3119:     }
                   3120:     
                   3121:     my $clause = Apache::lonxml::get_all_text('/clause', $parser);
                   3122:     $clause = eval('sub { my $helper = shift; my $state = shift; '
                   3123:         . $clause . '}');
1.11      bowersj2 3124:     die 'Error in clause of condition, Perl said: ' . $@ if $@;
1.8       bowersj2 3125:     if (!&$clause($helper, $paramHash)) {
                   3126:         # Discard all text until the /condition.
                   3127:         &Apache::lonxml::get_all_text('/condition', $parser);
                   3128:     }
                   3129: }
                   3130: 
                   3131: sub end_clause { return ''; }
1.11      bowersj2 3132: 
                   3133: =pod
                   3134: 
1.44      bowersj2 3135: =head2 General-purpose tag: <eval>X<eval, helper tag>
1.11      bowersj2 3136: 
                   3137: The <eval> tag will be evaluated as a subroutine call passed in the
                   3138: current helper object and state hash as described in <condition> above,
                   3139: but is expected to return a string to be printed directly to the
                   3140: screen. This is useful for dynamically generating messages. 
                   3141: 
                   3142: =cut
                   3143: 
                   3144: # This is basically a type of message.
                   3145: # Programmatically setting $paramHash->{NEXTSTATE} would work, though
                   3146: # it's probably bad form.
                   3147: 
                   3148: sub start_eval {
                   3149:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3150: 
                   3151:     if ($target ne 'helper') {
                   3152:         return '';
                   3153:     }
                   3154:     
                   3155:     my $program = Apache::lonxml::get_all_text('/eval', $parser);
                   3156:     $program = eval('sub { my $helper = shift; my $state = shift; '
                   3157:         . $program . '}');
                   3158:     die 'Error in eval code, Perl said: ' . $@ if $@;
                   3159:     $paramHash->{MESSAGE_TEXT} = &$program($helper, $paramHash);
                   3160: }
                   3161: 
                   3162: sub end_eval { 
                   3163:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3164: 
                   3165:     if ($target ne 'helper') {
                   3166:         return '';
                   3167:     }
                   3168: 
                   3169:     Apache::lonhelper::message->new();
                   3170: }
                   3171: 
1.13      bowersj2 3172: 1;
                   3173: 
1.27      bowersj2 3174: package Apache::lonhelper::final;
                   3175: 
                   3176: =pod
                   3177: 
1.44      bowersj2 3178: =head2 Element: finalX<final, helper tag>
1.27      bowersj2 3179: 
                   3180: <final> is a special element that works with helpers that use the <finalcode>
1.44      bowersj2 3181: tagX<finalcode, helper tag>. It goes through all the states and elements, executing the <finalcode>
1.27      bowersj2 3182: snippets and collecting the results. Finally, it takes the user out of the
                   3183: helper, going to a provided page.
                   3184: 
1.34      bowersj2 3185: If the parameter "restartCourse" is true, this will override the buttons and
                   3186: will make a "Finish Helper" button that will re-initialize the course for them,
                   3187: which is useful for the Course Initialization helper so the users never see
                   3188: the old values taking effect.
                   3189: 
1.93      albertel 3190: If the parameter "restartCourse" is not true a 'Finish' Button will be
                   3191: presented that takes the user back to whatever was defined as <exitpage>
                   3192: 
1.27      bowersj2 3193: =cut
                   3194: 
                   3195: no strict;
                   3196: @ISA = ("Apache::lonhelper::element");
                   3197: use strict;
1.62      matthew  3198: use Apache::lonlocal;
1.100     albertel 3199: use Apache::lonnet;
1.27      bowersj2 3200: BEGIN {
                   3201:     &Apache::lonhelper::register('Apache::lonhelper::final',
                   3202:                                  ('final', 'exitpage'));
                   3203: }
                   3204: 
                   3205: sub new {
                   3206:     my $ref = Apache::lonhelper::element->new();
                   3207:     bless($ref);
                   3208: }
                   3209: 
1.34      bowersj2 3210: sub start_final { 
                   3211:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3212: 
                   3213:     if ($target ne 'helper') {
                   3214:         return '';
                   3215:     }
                   3216: 
                   3217:     $paramHash->{'restartCourse'} = $token->[2]{'restartCourse'};
                   3218: 
                   3219:     return ''; 
                   3220: }
1.27      bowersj2 3221: 
                   3222: sub end_final {
                   3223:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3224: 
                   3225:     if ($target ne 'helper') {
                   3226:         return '';
                   3227:     }
                   3228: 
                   3229:     Apache::lonhelper::final->new();
                   3230:    
                   3231:     return '';
                   3232: }
                   3233: 
                   3234: sub start_exitpage {
                   3235:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3236: 
                   3237:     if ($target ne 'helper') {
                   3238:         return '';
                   3239:     }
                   3240: 
                   3241:     $paramHash->{EXIT_PAGE} = &Apache::lonxml::get_all_text('/exitpage',
                   3242:                                                             $parser);
                   3243: 
                   3244:     return '';
                   3245: }
                   3246: 
                   3247: sub end_exitpage { return ''; }
                   3248: 
                   3249: sub render {
                   3250:     my $self = shift;
                   3251: 
                   3252:     my @results;
                   3253: 
                   3254:     # Collect all the results
                   3255:     for my $stateName (keys %{$helper->{STATES}}) {
                   3256:         my $state = $helper->{STATES}->{$stateName};
                   3257:         
                   3258:         for my $element (@{$state->{ELEMENTS}}) {
                   3259:             if (defined($element->{FINAL_CODE})) {
                   3260:                 # Compile the code.
1.31      bowersj2 3261:                 my $code = 'sub { my $helper = shift; my $element = shift; ' 
                   3262:                     . $element->{FINAL_CODE} . '}';
1.27      bowersj2 3263:                 $code = eval($code);
                   3264:                 die 'Error while executing final code for element with var ' .
                   3265:                     $element->{'variable'} . ', Perl said: ' . $@ if $@;
                   3266: 
1.31      bowersj2 3267:                 my $result = &$code($helper, $element);
1.27      bowersj2 3268:                 if ($result) {
                   3269:                     push @results, $result;
                   3270:                 }
                   3271:             }
                   3272:         }
                   3273:     }
                   3274: 
1.40      bowersj2 3275:     my $result;
1.27      bowersj2 3276: 
1.40      bowersj2 3277:     if (scalar(@results) != 0) {
                   3278: 	$result .= "<ul>\n";
                   3279: 	for my $re (@results) {
                   3280: 	    $result .= '    <li>' . $re . "</li>\n";
                   3281: 	}
                   3282: 	
                   3283: 	if (!@results) {
1.59      bowersj2 3284: 	    $result .= '    <li>' . 
                   3285: 		&mt('No changes were made to current settings.') . '</li>';
1.40      bowersj2 3286: 	}
                   3287: 	
                   3288: 	$result .= '</ul>';
1.34      bowersj2 3289:     }
                   3290: 
1.93      albertel 3291:     my $actionURL = $self->{EXIT_PAGE};
                   3292:     my $targetURL = '';
                   3293:     my $finish=&mt('Finish');
1.34      bowersj2 3294:     if ($self->{'restartCourse'}) {
1.103     albertel 3295: 	$actionURL = '/adm/roles';
1.93      albertel 3296: 	$targetURL = '/adm/menu';
1.100     albertel 3297: 	if ($env{'course.'.$env{'request.course.id'}.'.url'}=~/^uploaded/) {
1.64      albertel 3298: 	    $targetURL = '/adm/coursedocs';
                   3299: 	} else {
                   3300: 	    $targetURL = '/adm/navmaps';
                   3301: 	}
1.100     albertel 3302: 	if ($env{'course.'.$env{'request.course.id'}.'.clonedfrom'}) {
1.45      bowersj2 3303: 	    $targetURL = '/adm/parmset?overview=1';
                   3304: 	}
1.93      albertel 3305: 	my $finish=&mt('Finish Course Initialization');
1.34      bowersj2 3306:     }
1.93      albertel 3307:     my $previous = HTML::Entities::encode(&mt("<- Previous"), '<>&"');
                   3308:     my $next = HTML::Entities::encode(&mt("Next ->"), '<>&"');
1.127     albertel 3309:     my $target = " target='loncapaclient'";
                   3310:     if (($env{'browser.interface'} eq 'textual') ||
                   3311:         ($env{'environment.remote'} eq 'off')) {  $target='';  }
1.93      albertel 3312:     $result .= "<center>\n" .
1.127     albertel 3313: 	"<form action='".$actionURL."' method='post' $target>\n" .
1.93      albertel 3314: 	"<input type='button' onclick='history.go(-1)' value='$previous' />" .
                   3315: 	"<input type='hidden' name='orgurl' value='$targetURL' />" .
                   3316: 	"<input type='hidden' name='selectrole' value='1' />\n" .
1.100     albertel 3317: 	"<input type='hidden' name='" . $env{'request.role'} . 
1.93      albertel 3318: 	"' value='1' />\n<input type='submit' value='" . $finish . "' />\n" .
                   3319: 	"</form></center>";
1.34      bowersj2 3320: 
1.40      bowersj2 3321:     return $result;
1.34      bowersj2 3322: }
                   3323: 
                   3324: sub overrideForm {
1.93      albertel 3325:     return 1;
1.27      bowersj2 3326: }
                   3327: 
                   3328: 1;
                   3329: 
1.13      bowersj2 3330: package Apache::lonhelper::parmwizfinal;
                   3331: 
                   3332: # This is the final state for the parmwizard. It is not generally useful,
                   3333: # so it is not perldoc'ed. It does its own processing.
                   3334: # It is represented with <parmwizfinal />, and
                   3335: # should later be moved to lonparmset.pm .
                   3336: 
                   3337: no strict;
                   3338: @ISA = ('Apache::lonhelper::element');
                   3339: use strict;
1.69      sakharuk 3340: use Apache::lonlocal;
1.102     albertel 3341: use Apache::lonnet;
1.11      bowersj2 3342: 
1.13      bowersj2 3343: BEGIN {
                   3344:     &Apache::lonhelper::register('Apache::lonhelper::parmwizfinal',
                   3345:                                  ('parmwizfinal'));
                   3346: }
                   3347: 
                   3348: use Time::localtime;
                   3349: 
                   3350: sub new {
                   3351:     my $ref = Apache::lonhelper::choices->new();
                   3352:     bless ($ref);
                   3353: }
                   3354: 
                   3355: sub start_parmwizfinal { return ''; }
                   3356: 
                   3357: sub end_parmwizfinal {
                   3358:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                   3359: 
                   3360:     if ($target ne 'helper') {
                   3361:         return '';
                   3362:     }
                   3363:     Apache::lonhelper::parmwizfinal->new();
                   3364: }
                   3365: 
                   3366: # Renders a form that, when submitted, will form the input to lonparmset.pm
                   3367: sub render {
                   3368:     my $self = shift;
                   3369:     my $vars = $helper->{VARS};
                   3370: 
                   3371:     # FIXME: Unify my designators with the standard ones
1.48      bowersj2 3372:     my %dateTypeHash = ('open_date' => "opening date",
                   3373:                         'due_date' => "due date",
                   3374:                         'answer_date' => "answer date",
                   3375: 			'tries' => 'number of tries',
                   3376: 			'weight' => 'problem weight'
1.38      bowersj2 3377: 			);
1.13      bowersj2 3378:     my %parmTypeHash = ('open_date' => "0_opendate",
                   3379:                         'due_date' => "0_duedate",
1.38      bowersj2 3380:                         'answer_date' => "0_answerdate",
1.48      bowersj2 3381: 			'tries' => '0_maxtries',
                   3382: 			'weight' => '0_weight' );
1.107     albertel 3383:     my %realParmName = ('open_date' => "opendate",
                   3384:                         'due_date' => "duedate",
                   3385:                         'answer_date' => "answerdate",
                   3386: 			'tries' => 'maxtries',
                   3387: 			'weight' => 'weight' );
1.13      bowersj2 3388:     
                   3389:     my $affectedResourceId = "";
                   3390:     my $parm_name = $parmTypeHash{$vars->{ACTION_TYPE}};
                   3391:     my $level = "";
1.27      bowersj2 3392:     my $resourceString;
                   3393:     my $symb;
                   3394:     my $paramlevel;
1.95      albertel 3395:     
1.13      bowersj2 3396:     # Print the granularity, depending on the action
                   3397:     if ($vars->{GRANULARITY} eq 'whole_course') {
1.76      sakharuk 3398:         $resourceString .= '<li>'.&mt('for <b>all resources in the course</b>').'</li>';
1.104     albertel 3399: 	if ($vars->{TARGETS} eq 'course') {
                   3400: 	    $level = 11; # general course, see lonparmset.pm perldoc
                   3401: 	} elsif ($vars->{TARGETS} eq 'section') {
                   3402: 	    $level = 6;
                   3403: 	} else {
                   3404: 	    $level = 3;
                   3405: 	}
1.13      bowersj2 3406:         $affectedResourceId = "0.0";
1.27      bowersj2 3407:         $symb = 'a';
                   3408:         $paramlevel = 'general';
1.13      bowersj2 3409:     } elsif ($vars->{GRANULARITY} eq 'map') {
1.41      bowersj2 3410:         my $navmap = Apache::lonnavmaps::navmap->new();
1.35      bowersj2 3411:         my $res = $navmap->getByMapPc($vars->{RESOURCE_ID});
1.13      bowersj2 3412:         my $title = $res->compTitle();
1.27      bowersj2 3413:         $symb = $res->symb();
1.78      sakharuk 3414:         $resourceString .= '<li>'.&mt('for the map named [_1]',"<b>$title</b>").'</li>';
1.104     albertel 3415: 	if ($vars->{TARGETS} eq 'course') {
                   3416: 	    $level = 10; # general course, see lonparmset.pm perldoc
                   3417: 	} elsif ($vars->{TARGETS} eq 'section') {
                   3418: 	    $level = 5;
                   3419: 	} else {
                   3420: 	    $level = 2;
                   3421: 	}
1.13      bowersj2 3422:         $affectedResourceId = $vars->{RESOURCE_ID};
1.27      bowersj2 3423:         $paramlevel = 'map';
1.13      bowersj2 3424:     } else {
1.41      bowersj2 3425:         my $navmap = Apache::lonnavmaps::navmap->new();
1.13      bowersj2 3426:         my $res = $navmap->getById($vars->{RESOURCE_ID});
1.95      albertel 3427:         my $part = $vars->{RESOURCE_ID_part};
                   3428: 	if ($part ne 'All Parts' && $part) { $parm_name=~s/^0/$part/; } else { $part=&mt('All Parts'); }
1.27      bowersj2 3429:         $symb = $res->symb();
1.13      bowersj2 3430:         my $title = $res->compTitle();
1.95      albertel 3431:         $resourceString .= '<li>'.&mt('for the resource named [_1] part [_2]',"<b>$title</b>","<b>$part</b>").'</li>';
1.104     albertel 3432: 	if ($vars->{TARGETS} eq 'course') {
                   3433: 	    $level = 7; # general course, see lonparmset.pm perldoc
                   3434: 	} elsif ($vars->{TARGETS} eq 'section') {
                   3435: 	    $level = 4;
                   3436: 	} else {
                   3437: 	    $level = 1;
                   3438: 	}
1.13      bowersj2 3439:         $affectedResourceId = $vars->{RESOURCE_ID};
1.27      bowersj2 3440:         $paramlevel = 'full';
1.13      bowersj2 3441:     }
                   3442: 
1.105     albertel 3443:     my $result = "<form name='helpform' method='POST' action='/adm/parmset#$affectedResourceId&$parm_name&$level'>\n";
1.104     albertel 3444:     $result .= "<input type='hidden' name='action' value='settable' />\n";
                   3445:     $result .= "<input type='hidden' name='dis' value='helper' />\n";
1.107     albertel 3446:     $result .= "<input type='hidden' name='pscat' value='".
                   3447: 	$realParmName{$vars->{ACTION_TYPE}}."' />\n";
1.95      albertel 3448:     if ($vars->{GRANULARITY} eq 'resource') {
                   3449: 	$result .= "<input type='hidden' name='symb' value='".
                   3450: 	    HTML::Entities::encode($symb,"'<>&\"") . "' />\n";
1.108     albertel 3451:     } elsif ($vars->{GRANULARITY} eq 'map') {
                   3452: 	$result .= "<input type='hidden' name='pschp' value='".
                   3453: 	    $affectedResourceId."' />\n";
1.95      albertel 3454:     }
1.104     albertel 3455:     my $part = $vars->{RESOURCE_ID_part};
                   3456:     if ($part eq 'All Parts' || !$part) { $part=0; }
                   3457:     $result .= "<input type='hidden' name='psprt' value='".
                   3458: 	HTML::Entities::encode($part,"'<>&\"") . "' />\n";
                   3459: 
1.69      sakharuk 3460:     $result .= '<p>'.&mt('Confirm that this information is correct, then click &quot;Finish Helper&quot; to complete setting the parameter.').'<ul>';
1.27      bowersj2 3461:     
                   3462:     # Print the type of manipulation:
1.73      albertel 3463:     my $extra;
1.38      bowersj2 3464:     if ($vars->{ACTION_TYPE} eq 'tries') {
1.73      albertel 3465: 	$extra =  $vars->{TRIES};
1.38      bowersj2 3466:     }
1.48      bowersj2 3467:     if ($vars->{ACTION_TYPE} eq 'weight') {
1.73      albertel 3468: 	$extra =  $vars->{WEIGHT};
                   3469:     }
                   3470:     $result .= "<li>";
1.74      matthew  3471:     my $what = &mt($dateTypeHash{$vars->{ACTION_TYPE}});
1.73      albertel 3472:     if ($extra) {
                   3473: 	$result .= &mt('Setting the [_1] to [_2]',"<b>$what</b>",$extra);
                   3474:     } else {
                   3475: 	$result .= &mt('Setting the [_1]',"<b>$what</b>");
1.48      bowersj2 3476:     }
1.38      bowersj2 3477:     $result .= "</li>\n";
1.27      bowersj2 3478:     if ($vars->{ACTION_TYPE} eq 'due_date' || 
                   3479:         $vars->{ACTION_TYPE} eq 'answer_date') {
                   3480:         # for due dates, we default to "date end" type entries
                   3481:         $result .= "<input type='hidden' name='recent_date_end' " .
                   3482:             "value='" . $vars->{PARM_DATE} . "' />\n";
                   3483:         $result .= "<input type='hidden' name='pres_value' " . 
                   3484:             "value='" . $vars->{PARM_DATE} . "' />\n";
                   3485:         $result .= "<input type='hidden' name='pres_type' " .
                   3486:             "value='date_end' />\n";
                   3487:     } elsif ($vars->{ACTION_TYPE} eq 'open_date') {
                   3488:         $result .= "<input type='hidden' name='recent_date_start' ".
                   3489:             "value='" . $vars->{PARM_DATE} . "' />\n";
                   3490:         $result .= "<input type='hidden' name='pres_value' " .
                   3491:             "value='" . $vars->{PARM_DATE} . "' />\n";
                   3492:         $result .= "<input type='hidden' name='pres_type' " .
                   3493:             "value='date_start' />\n";
1.38      bowersj2 3494:     } elsif ($vars->{ACTION_TYPE} eq 'tries') {
                   3495: 	$result .= "<input type='hidden' name='pres_value' " .
                   3496: 	    "value='" . $vars->{TRIES} . "' />\n";
1.104     albertel 3497:         $result .= "<input type='hidden' name='pres_type' " .
                   3498:             "value='int_pos' />\n";
1.48      bowersj2 3499:     } elsif ($vars->{ACTION_TYPE} eq 'weight') {
                   3500: 	$result .= "<input type='hidden' name='pres_value' " .
                   3501: 	    "value='" . $vars->{WEIGHT} . "' />\n";
1.38      bowersj2 3502:     }
1.27      bowersj2 3503: 
                   3504:     $result .= $resourceString;
                   3505:     
1.13      bowersj2 3506:     # Print targets
                   3507:     if ($vars->{TARGETS} eq 'course') {
1.76      sakharuk 3508:         $result .= '<li>'.&mt('for <b>all students in course</b>').'</li>';
1.13      bowersj2 3509:     } elsif ($vars->{TARGETS} eq 'section') {
                   3510:         my $section = $vars->{SECTION_NAME};
1.79      sakharuk 3511:         $result .= '<li>'.&mt('for section [_1]',"<b>$section</b>").'</li>';
1.104     albertel 3512: 	$result .= "<input type='hidden' name='csec' value='" .
1.89      foxr     3513:             HTML::Entities::encode($section,"'<>&\"") . "' />\n";
1.128     raeburn  3514:     } elsif ($vars->{TARGETS} eq 'group') {
                   3515:         my $group = $vars->{GROUP_NAME};
                   3516:         $result .= '<li>'.&mt('for group [_1]',"<b>$group</b>").'</li>';
                   3517:         $result .= "<input type='hidden' name='cgroup' value='" .
                   3518:             HTML::Entities::encode($group,"'<>&\"") . "' />\n";
1.13      bowersj2 3519:     } else {
                   3520:         # FIXME: This is probably wasteful! Store the name!
                   3521:         my $classlist = Apache::loncoursedata::get_classlist();
1.109     albertel 3522: 	my ($uname,$udom)=split(':',$vars->{USER_NAME});
1.106     albertel 3523:         my $name = $classlist->{$uname.':'.$udom}->[6];
1.79      sakharuk 3524:         $result .= '<li>'.&mt('for [_1]',"<b>$name</b>").'</li>';
1.13      bowersj2 3525:         $result .= "<input type='hidden' name='uname' value='".
1.89      foxr     3526:             HTML::Entities::encode($uname,"'<>&\"") . "' />\n";
1.13      bowersj2 3527:         $result .= "<input type='hidden' name='udom' value='".
1.89      foxr     3528:             HTML::Entities::encode($udom,"'<>&\"") . "' />\n";
1.13      bowersj2 3529:     }
                   3530: 
                   3531:     # Print value
1.48      bowersj2 3532:     if ($vars->{ACTION_TYPE} ne 'tries' && $vars->{ACTION_TYPE} ne 'weight') {
1.81      sakharuk 3533: 	$result .= '<li>'.&mt('to [_1] ([_2])',"<b>".ctime($vars->{PARM_DATE})."</b>",Apache::lonnavmaps::timeToHumanString($vars->{PARM_DATE}))."</li>\n";
1.38      bowersj2 3534:     }
                   3535:  
1.13      bowersj2 3536:     # print pres_marker
                   3537:     $result .= "\n<input type='hidden' name='pres_marker'" .
                   3538:         " value='$affectedResourceId&$parm_name&$level' />\n";
1.27      bowersj2 3539:     
                   3540:     # Make the table appear
                   3541:     $result .= "\n<input type='hidden' value='true' name='prevvisit' />";
                   3542:     $result .= "\n<input type='hidden' value='$symb' name='pssymb' />";
                   3543:     $result .= "\n<input type='hidden' value='$paramlevel' name='parmlev' />";
1.13      bowersj2 3544: 
1.71      sakharuk 3545:     $result .= "<br /><br /><center><input type='submit' value='".&mt('Finish Helper')."' /></center></form>\n";
1.13      bowersj2 3546: 
                   3547:     return $result;
                   3548: }
                   3549:     
                   3550: sub overrideForm {
                   3551:     return 1;
                   3552: }
1.5       bowersj2 3553: 
1.4       bowersj2 3554: 1;
1.3       bowersj2 3555: 
1.1       bowersj2 3556: __END__
1.3       bowersj2 3557: 

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