[BACK]Return to lonwizard.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/Attic/lonwizard.pm between versions 1.2 and 1.3

version 1.2, 2002/08/09 15:05:02 version 1.3, 2003/01/30 19:34:24
Line 90  sub new { Line 90  sub new {
   
 =over 2  =over 2
   
 =item B<new>(title): Returns a new instance of the given wizard type. "title" is the human-readable name of the wizard. A new wizard always starts on the B<START> state name.  =item * B<new>(title): Returns a new instance of the given wizard type. "title" is the human-readable name of the wizard. A new wizard always starts on the B<START> state name.
   
 =item B<declareVars>(varList): Call this function to declare the var names you want the wizard to maintain for you. The wizard will automatically output the hidden form fields and parse the values for you on the next call.  =item * B<declareVars>(varList): Call this function to declare the var names you want the wizard to maintain for you. The wizard will automatically output the hidden form fields and parse the values for you on the next call. This is a bulk declaration.
   
 =over 2  =over 2
   
Line 127  sub declareVars { Line 127  sub declareVars {
 sub _saveVars {  sub _saveVars {
     my $self = shift;      my $self = shift;
     my $result = "";      my $result = "";
     print $self->{VARS}{VAR1};  
     foreach my $varname (keys %{$self->{VARS}})      foreach my $varname (keys %{$self->{VARS}})
     {      {
  $result .= '<input type="hidden" name="' .   $result .= '<input type="hidden" name="' .
Line 202  sub display { Line 201  sub display {
     # Phase 2: Preprocess current state      # Phase 2: Preprocess current state
     my $startState = $self->{STATE};      my $startState = $self->{STATE};
     my $state = $self->{STATES}{$startState};      my $state = $self->{STATES}{$startState};
       
       # Error checking
       if (!defined($state)) {
           $result .="Error! The state ". $startState ." is not defined.";
           return $result;
       }
     $state->preprocess();      $state->preprocess();
   
     # Phase 3: While the current state is different from the previous state,      # Phase 3: While the current state is different from the previous state,
Line 215  sub display { Line 220  sub display {
   
     # Phase 4: Display.      # Phase 4: Display.
     my $stateTitle = $state->title();      my $stateTitle = $state->title();
       my $bodytag = &Apache::loncommon::bodytag("$self->{TITLE}",'','');
   
     $result .= <<HEADER;      $result .= <<HEADER;
 <html>  <html>
     <head>      <head>
         <title>LON-CAPA Wizard: $self->{NAME}</title>          <title>LON-CAPA Wizard: $self->{TITLE}</title>
     </head>      </head>
     <body bgcolor="#FFFFFF">      $bodytag
         <h1 style="font: Ariel">LON-CAPA Wizard: $self->{TITLE}</h1>  HEADER
       if (!$state->overrideForm()) { $result.="<form method='GET'>"; }
  <h2><i>$stateTitle</i></h2>      $result .= <<HEADER;
           <table border="0"><tr><td>
  <form method="GET">          <h2><i>$stateTitle</i></h2>
 HEADER  HEADER
   
     $result .= $self->_saveVars();      if (!$state->overrideForm()) {
           $result .= $self->_saveVars();
       }
     $result .= $state->render() . "<p>&nbsp;</p>";      $result .= $state->render() . "<p>&nbsp;</p>";
   
     if ($self->{STATE} ne $self->{START_STATE})      if (!$state->overrideForm()) {
     {          $result .= '<center>';
  $result .= '<input name="SUBMIT" type="submit" value="&lt;- Previous" />&nbsp;&nbsp;';          if ($self->{STATE} ne $self->{START_STATE})
     }          {
     if ($self->{DONE})              #$result .= '<input name="SUBMIT" type="submit" value="&lt;- Previous" />&nbsp;&nbsp;';
     {          }
  my $returnPage = $self->{RETURN_PAGE};          if ($self->{DONE})
  $result .= "<a href=\"$returnPage\">End Wizard</a>";          {
               my $returnPage = $self->{RETURN_PAGE};
               $result .= "<a href=\"$returnPage\">End Wizard</a>";
           }
           else
           {
               $result .= '<input name="SUBMIT" type="submit" value="Next -&gt;" />';
           }
           $result .= "</center>\n";
     }      }
     else  
     {  
  $result .= '<input name="SUBMIT" type="submit" value="Next -&gt;" />';  
     }  
       
   
     $result .= <<FOOTER;      $result .= <<FOOTER;
                 </td>
               </tr>
             </table>
         </form>          </form>
     </body>      </body>
 </html>  </html>
 FOOTER  FOOTER
   
       return $result;
 }  }
   
 =pod  =pod
Line 284  sub getVars { Line 300  sub getVars {
   
 =cut  =cut
   
   # This may look trivial, but it's here as a hook for possible later processing
 sub setVar {  sub setVar {
     my $self = shift;      my $self = shift;
     my $key = shift;      my $key = shift;
     my $val = shift;      my $val = shift;
     $self->{VARS}{$key} = $val;      $self->{VARS}{$key} = $val;
     print "set $key to $val<br>";  
 }  }
   
 =pod  =pod
Line 304  sub handler { Line 320  sub handler {
     my $r = shift;      my $r = shift;
   
     Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});      Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
       
     my $mes = "Using this wizard, you can <ul><li>change the due date of an assignment</li><li>change the due date for a whole map of assignments</li><li>change the due date for just one person</li></ul>";  
   
     my $wizard = Apache::lonwizard->new("Test Wizard");      if ($r->header_only) {
           if ($ENV{'browser.mathml'}) {
               $r->content_type('text/xml');
           } else {
               $r->content_type('text/html');
           }
           $r->send_http_header;
           return OK;
       }
   
       # Send header, don't cache this page
       if ($ENV{'browser.mathml'}) {
           $r->content_type('text/xml');
       } else {
           $r->content_type('text/html');
       }
       &Apache::loncommon::no_cache($r);
       $r->send_http_header;
       $r->rflush();
   
       my $mes = <<WIZBEGIN;
   <p>This wizard will allow you to</p>
   
   <ul>
     <li>Change assignment parameters, such as due date or open date...</li>
     <li>... for a whole class</li>
     <li>... for a whole section</li>
     <li>... for an individual student</li>
     <li>... by folder</li>
     <li>... by individual assignment</li>
   </ul>
   
     my $mesState = Apache::lonwizard::message_state->new($wizard, "START", "Welcome to the Assignment Parameter Wizard", $mes, "NEXT");  <p>After the wizard is done, you will be shown where in the advanced interface you would have gone to change the parameter you have chosen, so in the future you can do it directly.</p>
     my $mesState2 = Apache::lonwizard::choice_state->new($wizard, "NEXT", "Fucking the Cow", "How should the cow be fucked?", "Wow, with so many wonderful choices, how will you choose!?!", "START", "VAR1", {'standing & dildoated','standing & didldoated', 'rotten','rotten', 'sitting','sitting'});  WIZBEGIN
     $wizard->declareVars( ["VAR1", "VAR2", "VAR3"] );  
           
       my $wizard = Apache::lonwizard->new("Course Parameter Wizard");
       $wizard->declareVars(['ACTION_TYPE', 'GRANULARITY', 'TARGETS', 'PARM_DATE', 'RESOURCE_ID', 'USER_NAME', 'SECTION_NAME']);
       my %dateTypeHash = ('open_date' => "Opening Date",
                           'due_date' => "Due Date",
                           'answer_date' => "Answer Date");
       
       Apache::lonwizard::message_state->new($wizard, "START", "Welcome to the Assignment Parameter Wizard", $mes, "CHOOSE_ACTION");
       Apache::lonwizard::switch_state->new($wizard, "CHOOSE_ACTION", "What do you want to do?", "ACTION_TYPE", [ 
          ["open_date", "Set an Open Date for a problem", "CHOOSE_LEVEL"], 
          ["due_date", "Set a Due Date for a problem", "CHOOSE_LEVEL"],
          ["answer_date", "Set an Answer Open Date for a problem", "CHOOSE_LEVEL" ] ]);
       Apache::lonwizard::switch_state->new($wizard, "CHOOSE_LEVEL", "Parameter Granularity", "GRANULARITY", [
          ["whole_course", "Set for Whole Course", "CHOOSE_STUDENT_LEVEL"],
          ["map", "Set for a Folder/Map", "CHOOSE_FOLDER"],
          ["resource", "Set for a Particular Problem", "CHOOSE_RESOURCE"]],
                                            "How general should this setting be?");
       Apache::lonwizard::resource_choice->new($wizard, "CHOOSE_FOLDER", "Select Folder", "", "", "CHOOSE_STUDENT_LEVEL", "RESOURCE_ID", sub {my $res = shift; return $res->is_map();});
       Apache::lonwizard::resource_choice->new($wizard, "CHOOSE_RESOURCE", "Select Resource", "", "", "CHOOSE_STUDENT_LEVEL", "RESOURCE_ID", sub {my $res = shift; return $res->is_map() || $res->is_problem();}, sub {my $res = shift; return $res->is_problem(); });
       Apache::lonwizard::switch_state->new($wizard, "CHOOSE_STUDENT_LEVEL", "Parameter Targets", "TARGETS", [
          ["course", "Set for All Students in Course", "CHOOSE_DATE"],
          ["section", "Set for Section", "CHOOSE_SECTION"],
          ["student", "Set for an Individual Student", "CHOOSE_STUDENT"]],
                                          "Whom should this setting affect?");
   
       my $dateType = $dateTypeHash{$wizard->{VARS}->{ACTION_TYPE}};
       Apache::lonwizard::choose_section->new($wizard, "CHOOSE_SECTION", "Select Section", "Please select the section you wish to set the $dateType for:", "", "CHOOSE_DATE", "SECTION_NAME");
       Apache::lonwizard::choose_student->new($wizard, "CHOOSE_STUDENT", "Select Student", "Please select the student you wish to set the $dateType for:", "", "CHOOSE_DATE", "USER_NAME");
       Apache::lonwizard::date_state->new($wizard, "CHOOSE_DATE", "Set Date", "PARM_DATE", "FINISH", "What should the $dateType be set to?");
       Apache::lonwizard::parmwizfinal->new($wizard, "FINISH", "Confirm Selection");
   
     $r->print($wizard->display());      $r->print($wizard->display());
   
     return OK;      return OK;
Line 328  A "lonwizstate" object represents a lonw Line 401  A "lonwizstate" object represents a lonw
   
 Several pre-prepared child classes are include in lonwizard. If you create a new wizard type, be sure to add it to lonwizard.pm so others can use it too.  Several pre-prepared child classes are include in lonwizard. If you create a new wizard type, be sure to add it to lonwizard.pm so others can use it too.
   
   It is importent to remember when constructing states that the user may use the "Previous" button to go back and revisit a state previously filled out. Thus, states should consult the wizard variables they are intended to set to see if the user has already selected something, and when displaying themselves should reselect the same values, such that the user paging from the end to the beginning, back to the end, will not change any settings.
   
   None of the pre-packaged states correctly handle there being B<no> input, as the wizard does not currently have any protection against errors in the states themselves. (The closest thing you can do is set the wizard to be done and display an error message, which should be adequate.)
   
 =head2 lonwizstate methods  =head2 lonwizstate methods
   
 These methods should be overridden in derived states, except B<new> which may be sufficient.  These methods should be overridden in derived states, except B<new> which may be sufficient.
Line 392  sub postprocess { Line 469  sub postprocess {
     return 1;      return 1;
 }  }
   
   # If this is 1, the wizard assumes the state will override the 
   # wizard's form, useful for some final states
   sub overrideForm {
       return 0;
   }
   
 1;  1;
   
 =pod  =pod
Line 408  message_state is a state the simply disp Line 491  message_state is a state the simply disp
   
 =over 4  =over 4
   
 =item overridden method B<new>(parentLonWizReference, stateName, message, nextState): Two new parameters "message" will be the HTML message displayed to the user, and "nextState" is the name of the next state.  =item overridden method B<new>(parentLonWizReference, stateName, stateTitle, message, nextState): Two new parameters "message" will be the HTML message displayed to the user, and "nextState" is the name of the next state.
   
 =back  =back
   
Line 424  sub new { Line 507  sub new {
     my $proto = shift;      my $proto = shift;
     my $class = ref($proto) || $proto;      my $class = ref($proto) || $proto;
   
       # This cute looking statement correctly handles subclassing
     my $self = bless $proto->SUPER::new(shift, shift, shift);      my $self = bless $proto->SUPER::new(shift, shift, shift);
   
     $self->{MESSAGE} = shift;      $self->{MESSAGE} = shift;
Line 451  no strict; Line 535  no strict;
 @ISA = ("Apache::lonwizard::state");  @ISA = ("Apache::lonwizard::state");
 use strict;  use strict;
   
 sub new {  
     my $proto = shift;  
     my $class = ref($proto) || $proto;  
     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;  
     $self->{NO_CHOICES} = 0;  
 }  
   
 =pod  =pod
   
 =head2 Class: choice_state  =head2 Class: choice_state
Line 476  If there is only one choice, the state w Line 547  If there is only one choice, the state w
   
 =item overridden method B<new>(parentLonWizReference, stateName, stateTitle, messageBefore, messageAfter, nextState, varName, choiceHash): 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.  =item overridden method B<new>(parentLonWizReference, stateName, stateTitle, messageBefore, messageAfter, nextState, varName, choiceHash): 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.
   
   =back
   
 =cut  =cut
   
   sub new {
       my $proto = shift;
       my $class = ref($proto) || $proto;
       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;
       $self->{NO_CHOICES} = 0;
       
       return $self;
   }
   
 sub preprocess {  sub preprocess {
     my $self = shift;      my $self = shift;
     my %choices = %{$self->{CHOICE_HASH}};      my $choices = $self->{CHOICE_HASH};
     my %wizvars = %{$self->{WIZARD}->getVars()};      if (!defined($self->{CHOICE_HASH})) {
           $choices = $self->{CHOICE_HASH} = $self->determineChoices();
       }
       my $wizvars = $self->{WIZARD}->getVars();
   
     my @keys = keys(%choices);      my @keys = keys(%$choices);
     @keys = sort @keys;      @keys = sort @keys;
   
     if (scalar(@keys) == 0)      if (scalar(@keys) == 0)
     {      {
  # No choices... so prepare to display error message and cancel further execution.   # No choices... so prepare to display error message and cancel further execution.
  $self->{NO_CHOICES} = 1;   $self->{NO_CHOICES} = 1;
  $self->{WIZARD}->setDone();   $self->{WIZARD}->{DONE} = 1;
  return;   return;
     }      }
     if (scalar(@keys) == 1)      if (scalar(@keys) == 1)
     {      {
  # If there is only one choice, pick it and move on.   # If there is only one choice, pick it and move on.
  $wizvars{$self->{VAR_NAME}} = $choices{$keys[0]};   $wizvars->{$self->{VAR_NAME}} = $choices->{$keys[0]};
  $self->{WIZARD}->changeState($self->{NEXT_STATE});   $self->{WIZARD}->changeState($self->{NEXT_STATE});
  return;   return;
     }      }
Line 514  sub render { Line 605  sub render {
     my $self = shift;      my $self = shift;
     my $result = "";      my $result = "";
     my $var = $self->{VAR_NAME};      my $var = $self->{VAR_NAME};
     my %choices = %{$self->{CHOICE_HASH}};  
   
     if (!defined ($self->{CHOICE_HASH}))      if (defined $self->{ERROR_MSG}) {
     {          $result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
  $self->determineChoices();  
     }      }
   
     my %choices = %{$self->{CHOICE_HASH}};      if (defined $self->{MESSAGE_BEFORE})
     my @keys = keys (%choices);      {
    $result .= $self->{MESSAGE_BEFORE} . '<br /><br />';
       }
   
     $result .= "<select name=\"${var}.forminput\" size=\"10\">\n";      my $choices = $self->{CHOICE_HASH};
       my @keys = keys (%$choices);
   
       $result .= "<select name=\"$var.forminput\" size=\"10\">\n";
     foreach (@keys)      foreach (@keys)
     {      {
  $result .= "<option value=\"" . HTML::Entities::encode($choices{$_}) .   $result .= "<option value=\"" . HTML::Entities::encode($choices->{$_}) 
     "\">" . HTML::Entities::encode($_) . "\n";              . "\">" . HTML::Entities::encode($_) . "\n";
     }      }
   
     $result .= "</select>\n\n";      $result .= "</select>\n\n";
   
       if (defined $self->{MESSAGE_AFTER})
       {
    $result .= '<br /><br />' . $self->{MESSAGE_AFTER};
       }
   
     return $result;      return $result;
 }  }
   
 sub postprocess {  sub postprocess {
     my $self = shift;      my $self = shift;
     my $wizard = $self->{WIZARD};      my $wizard = $self->{WIZARD};
     $wizard->setVar($self->{VAR_NAME}, $ENV{"form." . $self->{VAR_NAME} . ".forminput"});      my $formvalue = $ENV{'form.' . $self->{VAR_NAME} . '.forminput'};
     $wizard->changeState($self->{NEXT_STATE});      if ($formvalue) {
           $wizard->setVar($self->{VAR_NAME}, $formvalue);
           $wizard->changeState($self->{NEXT_STATE});
       } else {
           $self->{ERROR_MSG} = "Can't continue the wizard because you must make"
               . ' a selection to continue.';
       }
     return 1;      return 1;
 }  }
   
Line 550  no strict; Line 654  no strict;
 @ISA = ("Apache::lonwizard::state");  @ISA = ("Apache::lonwizard::state");
 use strict;  use strict;
   
   =pod
   
   =head2 Class; switch_state
   
   Switch state provides the ability to present the user with several radio-button choices. The state can store the user response in a wizard variable, and can also send the user to a different state for each selection, which is the intended primary purpose.
   
   Each choice may have arbitrary HTML associated with it, which will be used as the label. The first choice will be selected by default.
   
   =over 4
   
   =item overridden method B<new>(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. messageBefore is an optional HTML string that will be placed before the message, messageAfter an optional HTML string that will be placed before.
   
   An example of a legit choiceList: C<my $choicelist = [ ["flunk", "Flunk Student", "FLUNK_STATE"], ["pass", "Pass Student", "PASS_STATE"] ];>
   
   =back
   
   =cut
   
   sub new {
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = bless $proto->SUPER::new(shift, shift, shift);
   
       $self->{VAR_NAME} = shift;
       $self->{CHOICE_LIST} = shift;
       $self->{MESSAGE_BEFORE} = shift;
       $self->{MESSAGE_AFTER} = shift;
   
       return $self;
   }
   
   # Don't need a preprocess step; we assume we know the choices
   
   sub render {
       my $self = shift;
       my $result = "";
       my $var = $self->{VAR_NAME};
       my @choices = @{$self->{CHOICE_LIST}};
       my $curVal = $self->{WIZARD}->{VARS}->{$var};
   
       $result .= $self->{MESSAGE_BEFORE} if (defined $self->{MESSAGE_BEFORE});
   
       if (!$curVal) {
           $curVal = $self->{CHOICE_LIST}->[0]->[0]; # top is default
       }
   
       $result .= "<table>\n\n";
   
       foreach my $choice (@choices)
       {
    my $value = $choice->[0];
    my $text = $choice->[1];
       
    $result .= "<tr>\n<td width='20'>&nbsp;</td>\n<td>";
    $result .= "<td valign=\"top\"><input type=\"radio\" name=\"$var.forminput\"";
    $result .= " checked" if ($value eq $curVal);
    $result .= " value=\"$value\"></td>\n<td>$text</td>\n</tr>\n\n";
       }
   
       $result .= "<table>\n\n";
   
       $result .= $self->{MESSAGE_AFTER} if (defined $self->{MESSAGE_AFTER});
   
       return $result;
   }
   
   sub postprocess {
       my $self = shift;
       my $wizard = $self->{WIZARD};
       my $chosenValue = $ENV{"form." . $self->{VAR_NAME} . '.forminput'};
       $wizard->setVar($self->{VAR_NAME}, $chosenValue)
    if (defined ($self->{VAR_NAME}));
   
       foreach my $choice (@{$self->{CHOICE_LIST}})
       {
    if ($choice->[0] eq $chosenValue)
    {
       $wizard->changeState($choice->[2]);
    }
       }
   }
   
   # If there is only one choice, make it and move on
   sub preprocess {
       my $self = shift;
       my $choiceList = $self->{CHOICE_LIST};
       my $wizard = $self->{WIZARD};
       
       if (scalar(@{$choiceList}) == 1)
       {
    my $choice = $choiceList->[0];
    my $chosenVal = $choice->[0];
    my $nextState = $choice->[2];
   
    $wizard->setVar($self->{VAR_NAME}, $chosenVal)
       if (defined ($self->{VAR_NAME}));
    $wizard->changeState($nextState);
       }
   }
   
   1;
   
   package Apache::lonwizard::date_state;
   
   use Time::localtime;
   use Time::Local;
   use Time::tm;
   
   no strict;
   @ISA = ("Apache::lonwizard::state");
   use strict;
   
   my @months = ("January", "February", "March", "April", "May", "June", "July",
         "August", "September", "October", "November", "December");
   
   =pod
   
   =head2 Class: date_state
   
   Date state provides a state for selecting a date/time, as seen in the course parmset wizard.. You can choose to display date entry if that's what you need.
   
   =over 4
   
   =item overriddent method B<new>(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.
   
   =back
   
   =cut
   
   sub new {
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = bless $proto->SUPER::new(shift, shift, shift);
   
       $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;
   }
   
   sub render {
       my $self = shift;
       my $result = "";
       my $var = $self->{VAR_NAME};
       my $name = $self->{NAME};
       my $wizvars = $self->{WIZARD}->getVars();
   
       my $date;
       
       # Pick default date: Now, or previous choice
       if (defined ($wizvars->{$var}) && $wizvars->{$var} ne "")
       { 
    $date = localtime($wizvars->{$var});
       }
       else
       {
    $date = localtime();
       }
   
       if (defined $self->{ERROR_MSG}) {
           $result .= '<font color="#FF0000">' . $self->{ERROR_MSG} . '</font><br /><br />';
       }
   
       if (defined ($self->{MESSAGE_BEFORE})) {
           $result .= $self->{MESSAGE_BEFORE};
           $result .= "<br /><br />\n\n";
       }
   
       # Month
       my $i;
       $result .= "<select name='$self->{VAR_NAME}month'>\n";
       for ($i = 0; $i < 12; $i++) {
           if ($i == $date->mon) {
               $result .= "<option value='$i' selected>";
           } else {
               $result .= "<option value='$i'>";
           }
           $result .= @months[$i] . "\n";
       }
       $result .= "</select>\n";
   
       # Day
       $result .= "<select name='$self->{VAR_NAME}day'>\n";
       for ($i = 1; $i < 32; $i++) {
           if ($i == $date->mday) {
               $result .= '<option selected>';
           } else {
               $result .= '<option>';
           }
           $result .= "$i\n";
       }
       $result .= "</select>,\n";
   
       # Year
       $result .= "<select name='$self->{VAR_NAME}year'>\n";
       for ($i = 2000; $i < 2030; $i++) { # update this after 64-bit dates
           if ($date->year + 1900 == $i) {
               $result .= "<option selected>";
           } else {
               $result .= "<option>";
           }
           $result .= "$i\n";
       }
       $result .= "</select>,\n";
   
       # Display Hours and Minutes if they are called for
       if (!$self->{DISPLAY_JUST_DATE}) {
           $result .= "<select name='$self->{VAR_NAME}hour'>\n";
           if ($date->hour == 12) { $result .= "<option selected>12\n"; }
           else { $result .= "<option>12\n" }
           for ($i = 1; $i < 12; $i++) {
               if (($date->hour) % 12 == $i % 12) {
                   $result .= "<option selected>";
               } else {
                   $result .= "<option>";
               }
               $result .= "$i\n";
           }
           $result .= "</select> :\n";
   
           $result .= "<select name='$self->{VAR_NAME}minute'>\n";
           for ($i = 0; $i < 60; $i++) {
               if ($date->min == $i) {
                   $result .= "<option selected>";
               } else {
                   $result .= "<option>";
               }
               $result .= "$i\n";
           }
           $result .= "</select>\n";
   
           $result .= "<select name='$self->{VAR_NAME}meridian'>\n";
           if ($date->hour < 12) {
               $result .= "<option selected>A.M.\n<option>P.M.\n";
           } else {
               $result .= "<option>A.M.\n<option selected>P.M.\n";
           }
           $result .= "</select>";
       }
   
       if (defined ($self->{MESSAGE_AFTER})) {
           $result .= "<br /><br />" . $self->{MESSAGE_AFTER};
       }
   
       return $result;
   }
   
   # Stick the date stored into the chosen variable.
   sub postprocess {
       my $self = shift;
       my $wizard = $self->{WIZARD};
   
       my $month = $ENV{'form.' . $self->{VAR_NAME} . 'month'}; 
       my $day = $ENV{'form.' . $self->{VAR_NAME} . 'day'}; 
       my $year = $ENV{'form.' . $self->{VAR_NAME} . 'year'}; 
       my $min = 0; 
       my $hour = 0;
       if (!$self->{DISPLAY_JUST_DATE}) {
           $min = $ENV{'form.' . $self->{VAR_NAME} . 'minute'};
           $hour = $ENV{'form.' . $self->{VAR_NAME} . 'hour'};
       }
   
       my $chosenDate = Time::Local::timelocal(0, $min, $hour, $day, $month, $year);
       # Check to make sure that the date was not automatically co-erced into a 
       # valid date, as we want to flag that as an error
       # This happens for "Feb. 31", for instance, which is coerced to March 2 or
       # 3, depending on if it's a leapyear
       my $checkDate = localtime($chosenDate);
   
       if ($checkDate->mon != $month || $checkDate->mday != $day ||
           $checkDate->year + 1900 != $year) {
           $self->{ERROR_MSG} = "Can't use " . $months[$month] . " $day, $year as a "
               . "date because it doesn't exist. Please enter a valid date.";
           return;
       }
   
       $wizard->setVar($self->{VAR_NAME}, $chosenDate);
   
       $wizard->changeState($self->{NEXT_STATE});
   }
   
   1;
   
   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.
   
   no strict;
   @ISA = ('Apache::lonwizard::state');
   use strict;
   
   use Time::localtime;
   
   sub new {
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = bless $proto->SUPER::new(shift, shift, shift);
   
       # No other variables because it gets it all from the wizard.
   }
   
   # Renders a form that, when submitted, will form the input to lonparmset.pm
   sub render {
       my $self = shift;
       my $wizard = $self->{WIZARD};
       my $wizvars = $wizard->{VARS};
   
       # FIXME: Unify my designators with the standard ones
       my %dateTypeHash = ('open_date' => "Opening Date",
                           'due_date' => "Due Date",
                           'answer_date' => "Answer Date");
       my %parmTypeHash = ('open_date' => "0_opendate",
                           'due_date' => "0_duedate",
                           'answer_date' => "0_answerdate");
       
       my $result = "<form method='get' action='/adm/parmset'>\n";
       $result .= '<p>Confirm that this information is correct, then click &quot;Finish Wizard&quot; to complete setting the parameter.<ul>';
       my $affectedResourceId = "";
       my $parm_name = $parmTypeHash{$wizvars->{ACTION_TYPE}};
       my $level = "";
       
       # Print the type of manipulation:
       $result .= '<li>Setting the <b>' . $dateTypeHash{$wizvars->{ACTION_TYPE}}
                  . "</b></li>\n";
       if ($wizvars->{ACTION_TYPE} eq 'due_date' || 
           $wizvars->{ACTION_TYPE} eq 'answer_date') {
           # for due dates, we default to "date end" type entries
           $result .= "<input type='hidden' name='recent_date_end' " .
               "value='" . $wizvars->{PARM_DATE} . "' />\n";
           $result .= "<input type='hidden' name='pres_value' " . 
               "value='" . $wizvars->{PARM_DATE} . "' />\n";
           $result .= "<input type='hidden' name='pres_type' " .
               "value='date_end' />\n";
       } elsif ($wizvars->{ACTION_TYPE} eq 'open_date') {
           $result .= "<input type='hidden' name='recent_date_start' ".
               "value='" . $wizvars->{PARM_DATE} . "' />\n";
           $result .= "<input type='hidden' name='pres_value' " .
               "value='" . $wizvars->{PARM_DATE} . "' />\n";
           $result .= "<input type='hidden' name='pres_type' " .
               "value='date_start' />\n";
       } 
       
       # Print the granularity, depending on the action
       if ($wizvars->{GRANULARITY} eq 'whole_course') {
           $result .= '<li>for <b>all resources in the course</b></li>';
           $level = 9; # general course, see lonparmset.pm perldoc
           $affectedResourceId = "0.0";
       } elsif ($wizvars->{GRANULARITY} eq 'map') {
           my $navmap = Apache::lonnavmaps::navmap->new(
                              $ENV{"request.course.fn"}.".db",
                              $ENV{"request.course.fn"}."_parms.db", 0, 0);
           my $res = $navmap->getById($wizvars->{RESOURCE_ID});
           my $title = $res->compTitle();
           $navmap->untieHashes();
           $result .= "<li>for the map named <b>$title</b></li>";
           $level = 8;
           $affectedResourceId = $wizvars->{RESOURCE_ID};
       } else {
           my $navmap = Apache::lonnavmaps::navmap->new(
                              $ENV{"request.course.fn"}.".db",
                              $ENV{"request.course.fn"}."_parms.db", 0, 0);
           my $res = $navmap->getById($wizvars->{RESOURCE_ID});
           my $title = $res->compTitle();
           $navmap->untieHashes();
           $result .= "<li>for the resource named <b>$title</b></li>";
           $level = 7;
           $affectedResourceId = $wizvars->{RESOURCE_ID};
       }
   
       # Print targets
       if ($wizvars->{TARGETS} eq 'course') {
           $result .= '<li>for <b>all students in course</b></li>';
       } elsif ($wizvars->{TARGETS} eq 'section') {
           my $section = $wizvars->{SECTION_NAME};
           $result .= "<li>for section <b>$section</b></li>";
           $level -= 3;
           $result .= "<input type='hidden' name='csec' value='" .
               HTML::Entities::encode($section) . "' />\n";
       } else {
           # FIXME: This is probably wasteful! 
           my $classlist = Apache::loncoursedata::get_classlist();
           my $name = $classlist->{$wizvars->{USER_NAME}}->[6];
           $result .= "<li>for <b>$name</b></li>";
           $level -= 6;
           my ($uname, $udom) = split /:/, $wizvars->{USER_NAME};
           $result .= "<input type='hidden' name='uname' value='".
               HTML::Entities::encode($uname) . "' />\n";
           $result .= "<input type='hidden' name='udom' value='".
               HTML::Entities::encode($udom) . "' />\n";
       }
   
       # Print value
       $result .= "<li>to <b>" . ctime($wizvars->{PARM_DATE}) . "</b> (" .
           Apache::lonnavmaps::timeToHumanString($wizvars->{PARM_DATE}) 
           . ")</li>\n";
   
       # print pres_marker
       $result .= "\n<input type='hidden' name='pres_marker'" .
           " value='$affectedResourceId&$parm_name&$level' />\n";
   
       $result .= "<br /><br /><center><input type='submit' value='Finish Wizard' /></center></form>\n";
   
       return $result;
   }
       
   sub overrideForm {
       return 1;
   }
   
   1;
   
   package Apache::lonwizard::resource_choice;
   
   =pod 
   
   =head2 Class: resource_choice
   
   folder_choice gives the user an opportunity to select one resource from the current course, and will stick the ID of that choice (#.#) into the desired variable.
   
   Note this state will not automatically advance if there is only one choice, because it might confuse the user in this case.
   
   =over 4
   
   =item overriddent method B<new>(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.
   
   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.
   
   =back
   
   =cut
   
   no strict;
   @ISA = ("Apache::lonwizard::state");
   use strict;
   
   sub new { 
       my $proto = shift;
       my $class = ref($proto) || $proto;
       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;
       if (!defined($self->{FILTER_FUNC})) {
           $self->{FILTER_FUNC} = sub {return 1;};
       }
       $self->{CHOICE_FUNC} = shift;
       if (!defined($self->{CHOICE_FUNC})) {
           $self->{CHOICE_FUNC} = $self->{FILTER_FUNC};
       }
   }
   
   sub postprocess {
       my $self = shift;
       my $wizard = $self->{WIZARD};
       my $chosenValue = $ENV{"form." . $self->{VAR_NAME} . ".forminput"};
       $wizard->setVar($self->{VAR_NAME}, $chosenValue)
           if (defined($self->{VAR_NAME}));
       
       $wizard->changeState($self->{NEXT_STATE});
   }
   
   sub render {
       my $self = shift;
       my $result = "";
       my $var = $self->{VAR_NAME};
       my $curVal = $self->{WIZARD}->{VARS}->{$var};
   
       $result .= $self->{MESSAGE_BEFORE} if (defined $self->{MESSAGE_BEFORE});
   
       # Get the course nav map
       my $navmap = Apache::lonnavmaps::navmap->new(
                              $ENV{"request.course.fn"}.".db",
                              $ENV{"request.course.fn"}."_parms.db", 0, 0);
   
       if (!defined($navmap)) {
           return "<font color='red' size='+1'>Something has gone wrong with the map selection feature. Please contact your administrator.</font>";
       }
   
       my $iterator = $navmap->getIterator(undef, undef, undef, 1, 0);
       my $depth = 1;
       $iterator->next(); # discard first BEGIN_MAP
       my $curRes = $iterator->next();
       my $i;
       my $padding = "&nbsp;&nbsp;";
       my $isChoosable = 0;
       my $filterFunc = $self->{FILTER_FUNC};
       my $choiceFunc = $self->{CHOICE_FUNC};
   
       $result .= "<table border='0'>\n";
   
       while ($depth > 0) {
           if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
           if ($curRes == $iterator->END_MAP()) { $depth--; }
   
           if (ref($curRes) && &$filterFunc($curRes)) {
               $result .= "<tr><td>";
   
               if (&$choiceFunc($curRes)) {
                   if (!$curVal) {
                       # Set this to the first one if they have no previous
                       # selection.
                       $curVal = $curRes->{ID}; 
                   }
   
                   $isChoosable = 1;
                   $result .= "<input type='radio' name='${var}.forminput'";
                   if ($curRes->{ID} eq $curVal) {
                       $result .= " checked";
                   }
                   $result .= ' value="' . $curRes->{ID} . '" />';
               }
   
               $result .= "</td><td>";
   
               for ($i = 0; $i < $depth; $i++) {
                   $result .= $padding;
               }
   
               #$result .= "<img border='0' src='/adm/lonIcons/navmap.folder.open.gif'>";
               $result .= $curRes->compTitle . "</td></tr>\n";
           }
   
           $curRes = $iterator->next();
       }
   
       $result .= "</table>\n";
   
       $navmap->untieHashes();
   
       if (!$isChoosable) {
           # FIXME: Check all the wiz vars for this.
           $result .= "<p><font color='#ff0000'>There are no valid resources to select in this course.</font> The entire course will be selected by default (as if 1you selected &quot;Set for Whole Course&quot; on the previous screen).</p>";
           $result .= "<input type='hidden' name='${var}.forminput' value='0.0' />\n";
       } 
   
       $result .= "<p>(Note: I need to add the icons in.)</p>";
       $result .= $self->{MESSAGE_AFTER} if (defined $self->{MESSAGE_AFTER});
   
       return $result;
   }
       
   1;
   
   package Apache::lonwizard::choose_student;
   
   no strict;
   @ISA = ("Apache::lonwizard::choice_state");
   use strict;
   
   sub new {
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = bless $proto->SUPER::new(shift, shift, shift, shift,
                                           shift, shift, shift);
       return $self;
   }
   
   sub determineChoices {
       my %choices;
   
       my $classlist = Apache::loncoursedata::get_classlist();
       foreach (keys %$classlist) {
           $choices{$classlist->{$_}->[6]} = $_;
       }
       
       return \%choices;
   }
   
   1;
   
   package Apache::lonwizard::choose_section;
   
   no strict;
   @ISA = ("Apache::lonwizard::choice_state");
   use strict;
   
   sub new {
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = bless $proto->SUPER::new(shift, shift, shift, shift,
                                           shift, shift, shift);
       return $self;
   }
   
   sub determineChoices {
       my %choices;
   
       my $classlist = Apache::loncoursedata::get_classlist();
       foreach (keys %$classlist) {
           my $sectionName = $classlist->{$_}->[5];
           if (!$sectionName) {
               $choices{"No section assigned"} = "";
           } else {
               $choices{$sectionName} = $sectionName;
           }
       }
       
       return \%choices;
   }
   
   1;
   
Removed from v.1.2  
changed lines
  Added in v.1.3

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>