--- loncom/interface/Attic/lonwizard.pm 2003/02/27 21:01:09 1.14 +++ loncom/interface/Attic/lonwizard.pm 2003/03/21 18:36:40 1.19 @@ -9,9 +9,9 @@ use Apache::lonnet; =head1 lonwizard - HTML "Wizard" framework for LON-CAPA -I know how most developers feel about Wizards, but the fact is they are a well-established UI widget that users feel comfortable with. It can take a complicated multi-dimensional problem the user has (such as the canonical Course Parameter example) and turn in into a series of bite-sized one-dimensional questions. Or take the some four-question form and put it in a Wizard, and present the same user with the same form outside of the Wizard, and the user will *think* the Wizard is easier. +Wizards are a well-established UI widget that users feel comfortable with. It can take a complicated multi-dimensional problem the user has (such as the canonical Course Parameter example) and turn in into a series of bite-sized one-dimensional questions. Or take the some four-question form and put it in a Wizard, and present the same user with the same form outside of the Wizard, and the user will *think* the Wizard is easier. -For the developer, wizards do provide an easy way to bundle easy bits of functionality for the user. It can be easier to write a Wizard then provide another custom interface. +For the developer, wizards do provide an easy way to bundle easy bits of functionality for the user, without having to write the tedious code for maintaining state between frames. It can be easier to write a Wizard then provide another custom interface. All classes are in the Apache::lonwizard namespace. @@ -19,12 +19,12 @@ All classes are in the Apache::lonwizard =cut -# To prevent runaway file counts, this file has lonwizard, -# lonwizstate, and other wizard classes. use strict; use HTML::Entities; use Apache::loncommon; +use Digest::MD5 qw(md5_hex); +use Apache::File; =pod @@ -76,8 +76,45 @@ sub new { $self->{STATE} = "START"; } - # set up return URL: Return the user to the referer page, unless the - # form has stored a value. + $self->{TOKEN} = $ENV{'form.TOKEN'}; + # If a token was passed, we load that in. Otherwise, we need to create a + # new storage file + # Tried to use standard Tie'd hashes, but you can't seem to take a + # reference to a tied hash and write to it. I'd call that a wart. + if ($self->{TOKEN}) { + # Validate the token before trusting it + if ($self->{TOKEN} !~ /^[a-f0-9]{32}$/) { + # Not legit. Return nothing and let all hell break loose. + # User shouldn't be doing that! + return undef; + } + + # Get the hash. + $self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN}); # Note the token is not the literal file + + my $file = Apache::File->new($self->{FILENAME}); + my $contents = <$file>; + &Apache::loncommon::get_unprocessed_cgi($contents); + $file->close(); + + # Marks whether this is a new wizard. + $self->{NEW_WIZARD} = 0; + } else { + # Only valid if we're just starting. + if ($self->{STATE} ne 'START') { + return undef; + } + # Must create the storage + $self->{TOKEN} = md5_hex($ENV{'user.name'} . $ENV{'user.domain'} . + time() . rand()); + $self->{FILENAME} = $Apache::lonnet::tmpdir . md5_hex($self->{TOKEN}); + + # Marks whether this is a new wizard. + $self->{NEW_WIZARD} = 1; + } + + # OK, we now have our persistent storage. + if (defined $ENV{"form.RETURN_PAGE"}) { $self->{RETURN_PAGE} = $ENV{"form.RETURN_PAGE"}; @@ -88,7 +125,6 @@ sub new { } $self->{STATES} = {}; - $self->{VARS} = {}; $self->{HISTORY} = {}; $self->{DONE} = 0; @@ -131,14 +167,15 @@ sub declareVars { foreach my $element ( @{$varlist} ) { # assign the var the default of "" - $self->{VARS}{$element} = ""; + $self->{VARS}->{$element} = ""; - # if there's a form in the env, use that instead - my $envname = "form." . $element; - if (defined ($ENV{$envname})) { - $self->{VARS}->{$element} = $ENV{$envname}; - } + my $envname; + $envname = "form." . $element; + if (defined ($ENV{$envname})) { + $self->{VARS}->{$element} = $ENV{$envname}; + } + # If there's an incoming form submission, use that $envname = "form." . $element . ".forminput"; if (defined ($ENV{$envname})) { @@ -147,32 +184,36 @@ sub declareVars { } } -# Private function; takes all of the declared vars and returns a string -# corresponding to the hidden input fields that will re-construct the -# variables. +# Private function; returns a string to construct the hidden fields +# necessary to have the wizard track state. sub _saveVars { my $self = shift; my $result = ""; - foreach my $varname (keys %{$self->{VARS}}) - { - $result .= '\n"; - } - - # also save state & return page $result .= '' . "\n"; + HTML::Entities::encode($self->{STATE}) . "\" />\n"; + $result .= '\n"; $result .= '' . "\n"; + HTML::Entities::encode($self->{RETURN_PAGE}) . "\" />\n"; return $result; } +# Private function: Create the querystring-like representation of the stored +# data to write to disk. +sub _varsInFile { + my $self = shift; + my @vars = (); + for my $key (keys %{$self->{VARS}}) { + push @vars, &Apache::lonnet::escape($key) . '=' . + &Apache::lonnet::escape($self->{VARS}->{$key}); + } + return join ('&', @vars); +} + =pod -=item B(referenceToStateObj): Registers a state as part of the wizard, so the wizard can use it. The 'referenceToStateObj' should be a reference to an instantiated lonwizstate object. This is normally called at the end of the lonwizstate constructor. +=item B(referenceToStateObj): Registers a state as part of the wizard, so the wizard can use it. The 'referenceToStateObj' should be a reference to an instantiated lonwizstate object. This is normally called at the end of the lonwizard::state constructor, so you should not normally need it as a user. =cut @@ -197,11 +238,11 @@ sub changeState { =pod -=item B(): This is the main method that the handler using the wizard calls. - +=item B(): This is the main method that the handler using the wizard calls. It must always be called, and called last, because it takes care of closing a hash that needs to be closed. +sxsd =cut -# Done in five phases +# Done in four phases # 1: Do the post processing for the previous state. # 2: Do the preprocessing for the current state. # 3: Check to see if state changed, if so, postprocess current and move to next. @@ -213,9 +254,9 @@ sub display { my $result = ""; # Phase 1: Post processing for state of previous screen (which is actually - # the current state), if it wasn't the beginning state. - if ($self->{STATE} ne "START" || $ENV{"form.SUBMIT"} eq "Next ->") - { + # the "current state" in terms of the wizard variables), if it wasn't the + # beginning state. + if ($self->{STATE} ne "START" || $ENV{"form.SUBMIT"} eq "Next ->") { my $prevState = $self->{STATES}{$self->{STATE}}; $prevState->postprocess(); } @@ -228,7 +269,8 @@ sub display { my $startState = $self->{STATE}; my $state = $self->{STATES}{$startState}; - # Error checking + # Error checking; it is intended that the developer will have + # checked all paths and the user can't see this! if (!defined($state)) { $result .="Error! The state ". $startState ." is not defined."; return $result; @@ -268,17 +310,14 @@ HEADER if (!$state->overrideForm()) { $result .= '
'; - if ($self->{STATE} ne $self->{START_STATE}) - { + if ($self->{STATE} ne $self->{START_STATE}) { #$result .= '  '; } - if ($self->{DONE}) - { + if ($self->{DONE}) { my $returnPage = $self->{RETURN_PAGE}; $result .= "End Wizard"; } - else - { + else { $result .= ' FOOTER + # Handle writing out the vars to the file + my $file = Apache::File->new('>'.$self->{FILENAME}); + print $file $self->_varsInFile(); + return $result; } @@ -328,12 +371,11 @@ sub getVars { =cut -# This may look trivial, but it's here as a hook for possible later processing sub setVar { my $self = shift; my $key = shift; my $val = shift; - $self->{VARS}{$key} = $val; + $self->{VARS}->{$key} = $val; } =pod @@ -345,12 +387,11 @@ sub setVar { sub queryStringVars { my $self = shift; + my @storedVars = ('STATE', 'TOKEN', 'RETURN_PAGE'); my @queryString = (); - for my $varname (keys %{$self->{VARS}}) { - push @queryString, Apache::lonnet::escape($varname) . "=" . - Apache::lonnet::escape($self->{VARS}{$varname}); - } + push @queryString, 'TOKEN=' . + Apache::lonnet::escape($self->{TOKEN}); push @queryString, 'CURRENT_STATE=' . Apache::lonnet::escape($self->{STATE}); push @queryString, 'RETURN_PAGE=' . Apache::lonnet::escape($self->{RETURN_PAGE}); @@ -363,7 +404,6 @@ sub queryStringVars { =cut - # A temp function for debugging sub handler { my $r = shift; @@ -413,8 +453,8 @@ WIZBEGIN ["map", "Every problem in a particular folder", "CHOOSE_FOLDER"], ["resource", "One particular problem", "CHOOSE_RESOURCE"]], "Which problems do you wish to change a date for?"); - Apache::lonwizard::resource_choice->new($wizard, "CHOOSE_FOLDER", "Select Folder", "Select the folder you wish to set the date for:", "", "CHOOSE_ACTION", "RESOURCE_ID", sub {my $res = shift; return $res->is_map();}); - Apache::lonwizard::resource_choice->new($wizard, "CHOOSE_RESOURCE", "Select Resource", "", "", "CHOOSE_ACTION", "RESOURCE_ID", sub {my $res = shift; return $res->is_map() || $res->is_problem();}, sub {my $res = shift; return $res->is_problem(); }); + Apache::lonwizard::resource_choice->new($wizard, "CHOOSE_FOLDER", "Select Folder", "Select the folder you wish to set the date for:", "CHOOSE_ACTION", "RESOURCE_ID", sub {my $res = shift; return $res->is_map();}); + Apache::lonwizard::resource_choice->new($wizard, "CHOOSE_RESOURCE", "Select Resource", "", "CHOOSE_ACTION", "RESOURCE_ID", sub {my $res = shift; return $res->is_map() || $res->is_problem();}, sub {my $res = shift; return $res->is_problem(); }); my $levelType = $levelTypeHash{$wizard->{VARS}->{GRANULARITY}}; Apache::lonwizard::switch_state->new($wizard, "CHOOSE_ACTION", "Parameter Type", "ACTION_TYPE", [ ["open_date", "Set an open date", "CHOOSE_DATE"], @@ -429,8 +469,8 @@ WIZBEGIN ["student", ". . . for an individual student", "CHOOSE_STUDENT"]], "Set $dateType of $levelType for. . ."); - Apache::lonwizard::choose_section->new($wizard, "CHOOSE_SECTION", "Select Section", "Please select the section you wish to set the $dateType for:", "", "FINISH", "SECTION_NAME"); - Apache::lonwizard::choose_student->new($wizard, "CHOOSE_STUDENT", "Select Student", "Please select the student you wish to set the $dateType for:", "", "FINISH", "USER_NAME"); + Apache::lonwizard::choose_section->new($wizard, "CHOOSE_SECTION", "Select Section", "Please select the section you wish to set the $dateType for:", "FINISH", "SECTION_NAME"); + Apache::lonwizard::choose_student->new($wizard, "CHOOSE_STUDENT", "Select Student", "Please select the student you wish to set the $dateType for:", "FINISH", "USER_NAME"); Apache::lonwizard::parmwizfinal->new($wizard, "FINISH", "Confirm Selection"); $r->print($wizard->display()); @@ -626,7 +666,7 @@ If there is only one choice, the state w =over 4 -=item overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, messageAfter, nextState, varName, choiceHash, multichoice): messageBefore is the HTML text that will be displayed before the choice display, messageAfter will display after. Keys will be sorted according to human name. nextState is the state to proceed to after the choice. varName is the name of the wizard var to store the computer_name answer in. choiceHash is the hash described above. It is optional because you may override it. multichoice is true if the user can make multiple choices, false otherwise. (Multiple choices will be seperated with ||| in the wizard variable. +=item overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, nextState, varName, choiceHash, multichoice): messageBefore is the HTML text that will be displayed before the choice display. Keys will be sorted according to human name. nextState is the state to proceed to after the choice. varName is the name of the wizard var to store the computer_name answer in. choiceHash is the hash described above. It is optional because you may override it. multichoice is true if the user can make multiple choices, false otherwise. (Multiple choices will be seperated with ||| in the wizard variable. =back @@ -638,7 +678,6 @@ sub new { my $self = bless $proto->SUPER::new(shift, shift, shift); $self->{MESSAGE_BEFORE} = shift; - $self->{MESSAGE_AFTER} = shift; $self->{NEXT_STATE} = shift; $self->{VAR_NAME} = shift; $self->{CHOICE_HASH} = shift; @@ -680,7 +719,8 @@ sub preprocess { } sub determineChoices { - return {"NO_CHOICE" => "No choices were given."}; + # Return no choices, which will terminate the wizard + return {}; } sub render { @@ -730,10 +770,6 @@ BUTTONS . "\"/> " . HTML::Entities::encode($_) . "
\n"; } - if (defined $self->{MESSAGE_AFTER}) { - $result .= '

' . $self->{MESSAGE_AFTER}; - } - return $result; } @@ -771,7 +807,7 @@ Each choice may have arbitrary HTML asso =over 4 -=item overridden method B(parentLonWizReference, stateName, stateTitle, varName, choiceList, messageBefore, messageAfter): varName is the name of the wizard variable the state will set with the choice made. choiceHash is list reference of a list of list references to three element lists, where the first element is what the wizard var varName will be set to, the second is the HTML that will be displayed for that choice, and the third is the destination state. The special setting 'ILLEGAL' can be used in the first place to state that it is not a legal chocie (see lonprintout.pm for real-life usage of that). messageBefore is an optional HTML string that will be placed before the message, messageAfter an optional HTML string that will be placed before. +=item overridden method B(parentLonWizReference, stateName, stateTitle, varName, choiceList, messageBefore): varName is the name of the wizard variable the state will set with the choice made. choiceHash is list reference of a list of list references to three element lists, where the first element is what the wizard var varName will be set to, the second is the HTML that will be displayed for that choice, and the third is the destination state. The special setting 'ILLEGAL' can be used in the first place to state that it is not a legal chocie (see lonprintout.pm for real-life usage of that). messageBefore is an optional HTML string that will be placed before the message. Note that ILLEGAL is desirable because some choices may not always be good choices, but they should not necessarily disappear with no explanantion of why they are no good. In lonprintout.pm, for instance, the choice "Problems from current sequence" may be no good because there are no problems in the sequence, but it should not silently disappear; it should announce that there are no problems in the sequence. @@ -789,7 +825,6 @@ sub new { $self->{VAR_NAME} = shift; $self->{CHOICE_LIST} = shift; $self->{MESSAGE_BEFORE} = shift; - $self->{MESSAGE_AFTER} = shift; return $self; } @@ -805,27 +840,24 @@ sub render { $result .= $self->{MESSAGE_BEFORE} if (defined $self->{MESSAGE_BEFORE}); - if (!$curVal) { - $curVal = $self->{CHOICE_LIST}->[0]->[0]; # top is default - } - $result .= "\n\n"; - foreach my $choice (@choices) - { + my $checked = 0; + foreach my $choice (@choices) { my $value = $choice->[0]; my $text = $choice->[1]; $result .= "\n\n\n\n\n\n"; } $result .= "
 "; $result .= "$text
\n\n"; - $result .= $self->{MESSAGE_AFTER} if (defined $self->{MESSAGE_AFTER}); - return $result; } @@ -835,10 +867,8 @@ sub postprocess { my $wizard = $self->{WIZARD}; my $chosenValue = $ENV{"form." . $self->{VAR_NAME} . '.forminput'}; - foreach my $choice (@{$self->{CHOICE_LIST}}) - { - if ($choice->[0] eq $chosenValue) - { + foreach my $choice (@{$self->{CHOICE_LIST}}) { + if ($choice->[0] eq $chosenValue) { $wizard->changeState($choice->[2]); } } @@ -850,8 +880,7 @@ sub preprocess { my $choiceList = $self->{CHOICE_LIST}; my $wizard = $self->{WIZARD}; - if (scalar(@{$choiceList}) == 1) - { + if (scalar(@{$choiceList}) == 1) { my $choice = $choiceList->[0]; my $chosenVal = $choice->[0]; my $nextState = $choice->[2]; @@ -885,7 +914,7 @@ Date state provides a state for selectin =over 4 -=item overriddent method B(parentLonWizReference, stateName, stateTitle, varName, nextState, messageBefore, messageAfter, displayJustDate): varName is where the date/time will be stored as seconds since the epoch. messageBefore and messageAfter as other states. displayJustDate is a flag defaulting to false that if true, will only display the date selection (defaulting to midnight on that date). Otherwise, minutes and hours will be shown. +=item overriddent method B(parentLonWizReference, stateName, stateTitle, varName, nextState, messageBefore, displayJustDate): varName is where the date/time will be stored as seconds since the epoch. messageBefore and messageAfter as other states. displayJustDate is a flag defaulting to false that if true, will only display the date selection (defaulting to midnight on that date). Otherwise, minutes and hours will be shown. =back @@ -899,7 +928,6 @@ sub new { $self->{VAR_NAME} = shift; $self->{NEXT_STATE} = shift; $self->{MESSAGE_BEFORE} = shift; - $self->{MESSAGE_AFTER} = shift; $self->{DISPLAY_JUST_DATE} = shift; if (!defined($self->{DISPLAY_JUST_DATE})) {$self->{DISPLAY_JUST_DATE} = 0;} return $self; @@ -914,15 +942,9 @@ sub render { my $date; - # Pick default date: Now, or previous choice - if (defined ($wizvars->{$var}) && $wizvars->{$var} ne "") - { - $date = localtime($wizvars->{$var}); - } - else - { - $date = localtime(); - } + # Default date: Now + $date = localtime(); + $date->min = 0; if (defined $self->{ERROR_MSG}) { $result .= '' . $self->{ERROR_MSG} . '

'; @@ -1058,7 +1080,7 @@ sub postprocess { package Apache::lonwizard::parmwizfinal; # This is the final state for the parmwizard. It is not generally useful, -# so it is not perldoc'ed. It does it's own processing. +# so it is not perldoc'ed. It does its own processing. no strict; @ISA = ('Apache::lonwizard::state'); @@ -1196,7 +1218,7 @@ Note this state will not automatically a =over 4 -=item overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, messageAfter, nextState, varName, filterFunction, choiceFunction): messageBefore and messageAfter appear before and after the state choice, respectively. nextState is the state to proceed to after the choice. varName is the wizard variable to store the choice in. +=item overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, nextState, varName, filterFunction, choiceFunction): messageBefore and messageAfter appear before and after the state choice, respectively. nextState is the state to proceed to after the choice. varName is the wizard variable to store the choice in. filterFunction is a function reference that receives the current resource as an argument, and returns 1 if it should be displayed, and 0 if it should not be displayed. By default, the class will use sub {return 1;}, which will show all resources. choiceFunction is a reference to a function that receives the resource object as a parameter and returns 1 if it should be a *selectable choice*, and 0 if not. By default, this is the same as the filterFunction, which means all displayed choices will be choosable. See parm wizard for an example of this in the resource selection routines. @@ -1214,7 +1236,6 @@ sub new { my $self = bless $proto->SUPER::new(shift, shift, shift); $self->{MESSAGE_BEFORE} = shift; - $self->{MESSAGE_AFTER} = shift; $self->{NEXT_STATE} = shift; $self->{VAR_NAME} = shift; $self->{FILTER_FUNC} = shift; @@ -1288,6 +1309,9 @@ sub render { my $choiceFunc = $self->{CHOICE_FUNC}; # Create the composite function that renders the column on the nav map + # have to admit any language that lets me do this can't be all bad + # - Jeremy (Pythonista) ;-) + my $checked = 0; my $renderColFunc = sub { my ($resource, $part, $params) = @_; @@ -1295,10 +1319,11 @@ sub render { return ''; } else { my $col = ""; + $col .= "value='" . $resource->symb() . "' />"; return $col; } }; @@ -1311,8 +1336,6 @@ sub render { 'url' => $wizard->{URL}, 'filterFunc' => $filterFunc } ); - $result .= $self->{MESSAGE_AFTER} if (defined $self->{MESSAGE_AFTER}); - return $result; } @@ -1334,7 +1357,7 @@ Note this class is generally useful for =over 4 -=item overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, messageAfter, nextState, varName, filterFunction, choiceFunction, map): Arguments like resource_choice. map is the ID number of a specific map that, if given is all that will be shown to the user, instead of the whole course. +=item overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, nextState, varName, filterFunction, choiceFunction, map): Arguments like resource_choice. map is the ID number of a specific map that, if given is all that will be shown to the user, instead of the whole course. =back @@ -1350,7 +1373,6 @@ sub new { my $self = bless $proto->SUPER::new(shift, shift, shift); $self->{MESSAGE_BEFORE} = shift; - $self->{MESSAGE_AFTER} = shift; $self->{NEXT_STATE} = shift; $self->{VAR_NAME} = shift; $self->{FILTER_FUNC} = shift; @@ -1438,8 +1460,6 @@ BUTTONS $result .= $buttons; - $result .= $self->{MESSAGE_AFTER} if (defined $self->{MESSAGE_AFTER}); - return $result; } 1; @@ -1500,12 +1520,15 @@ BUTTONS my @keys = keys %{$choices}; # Sort by: Section, name - + + my $section = Apache::loncoursedata::CL_SECTION(); + my $fullname = Apache::loncoursedata::CL_FULLNAME(); + @keys = sort { - if ($choices->{$a}->[3] ne $choices->{$b}->[3]) { - return $choices->{$a}->[3] cmp $choices->{$b}->[3]; + if ($choices->{$a}->[$section] ne $choices->{$b}->[$section]) { + return $choices->{$a}->[$section] cmp $choices->{$b}->[$section]; } - return $choices->{$a}->[6] cmp $choices->{$b}->[6]; + return $choices->{$a}->[$fullname] cmp $choices->{$b}->[$fullname]; } @keys; my $type = 'radio'; @@ -1518,9 +1541,10 @@ BUTTONS $result .= "\n"; } @@ -1592,7 +1616,7 @@ choose_file offers a choice of files fro =over 4 -=item * overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, messageAfter, nextState, varName, subdir, filterFunc): As in previous states, where filterFunc is as described in choose_file. subdir is the name of the subdirectory to offer choices from. +=item * overridden method B(parentLonWizReference, stateName, stateTitle, messageBefore, nextState, varName, subdir, filterFunc): As in previous states, where filterFunc is as described in choose_file. subdir is the name of the subdirectory to offer choices from. =back @@ -1608,7 +1632,6 @@ sub new { my $self = bless $proto->SUPER::new(shift, shift, shift); $self->{MESSAGE_BEFORE} = shift; - $self->{MESSAGE_AFTER} = shift; $self->{NEXT_STATE} = shift; $self->{VAR_NAME} = shift; $self->{SUB_DIR} = shift; @@ -1697,10 +1720,6 @@ BUTTONS $result .= $buttons; - if ($self->{MESSAGE_AFTER}) { - $result .= "

" . $self->{MESSAGE_AFTER}; - } - return $result; }
 {$resource->{ID}}) { + if (!$checked) { $col .= "checked "; + $checked = 1; } - $col .= "value='" . $resource->{ID} . "' />
" . HTML::Entities::encode($choices->{$_}->[6]) + . "' />" + . HTML::Entities::encode($choices->{$_}->[$fullname]) . "" - . HTML::Entities::encode($choices->{$_}->[5]) + . HTML::Entities::encode($choices->{$_}->[$section]) . "