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