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