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