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