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