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