--- loncom/interface/lonprintout.pm 2003/03/13 18:35:12 1.129
+++ loncom/interface/lonprintout.pm 2003/04/30 19:18:37 1.135
@@ -1,7 +1,7 @@
# The LearningOnline Network
# Printout
#
-# $Id: lonprintout.pm,v 1.129 2003/03/13 18:35:12 albertel Exp $
+# $Id: lonprintout.pm,v 1.135 2003/04/30 19:18:37 bowersj2 Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -1221,11 +1221,15 @@ sub latex_corrections {
sub handler {
my $r = shift;
+ my $helper;
# A hook for me to work without disturbing Alex.
if (!$ENV{'form.jeremy'}) {
- printWizard($r);
- return OK;
+ my $result = printHelper($r);
+ if (!ref($result)) {
+ return $result;
+ }
+ $helper = $result;
}
my $loaderror=&Apache::lonnet::overloaderror($r);
@@ -1281,9 +1285,9 @@ sub handler {
}
-use Apache::lonwizard;
+use Apache::lonhelper;
-sub printWizard {
+sub printHelper {
my $r = shift;
if ($ENV{'request.course.id'}) {
@@ -1311,73 +1315,163 @@ sub printWizard {
$r->send_http_header;
$r->rflush();
+ # Unfortunately, this helper is so complicated we have to
+ # write it by hand
+
+ Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
+
+ my $helper = Apache::lonhelper::helper->new("Printing Wizard");
+
+ # This will persistently load in the data we want from the
+ # very first screen.
+ if (defined($ENV{'form.symb'})) {
+ $helper->{VARS}->{'symb'} = $ENV{'form.symb'};
+ }
+ if (defined($ENV{'form.postdata'})) {
+ $helper->{VARS}->{'postdata'} = $ENV{'form.postdata'};
+ }
+ if (defined($ENV{'form.url'})) {
+ $helper->{VARS}->{'url'} = $ENV{'form.url'};
+ }
+
my ($resourceTitle,$sequenceTitle,$mapTitle) = &details_for_menu;
if (!$resourceTitle) { # if the resource doesn't have a title, use the filename
- my $url = $ENV{'form.postdata'};
+ my $url = $helper->{VARS}->{'postdata'};
$resourceTitle = substr($url, rindex($url, '/') + 1);
}
- my $wizard = Apache::lonwizard->new("Printing Wizard", $ENV{QUERY_STRING});
- # PRINT_TYPE: What the user wants to print (current docs,
- # whole sequence, etc.
- $wizard->declareVars(['PRINT_TYPE', 'FORMAT', 'postdata', 'url',
- 'symb', 'RESOURCES', 'FILES', 'STUDENTS']);
+ Apache::lonhelper::registerHelperTags();
# Extract map
- my $symb = $wizard->{VARS}->{'symb'};
+ my $symb = $helper->{VARS}->{'symb'};
my ($map, $id, $url) = split(/__/, $symb);
- my $subdir = &Apache::lonnet::filelocation("", $ENV{'form.url'});
+ my $subdir = &Apache::lonnet::filelocation("", $helper->{VARS}->{'postdata'});
# "Delete everything after the last slash."
$subdir =~ s|/[^/]+$||;
- # This really ought to be in some repository in loncommon or
- # something where it can just be grabbed.
- my $problemFilter = sub {
- my $name = shift;
- return $name =~ m/^[^\.]+\.(problem|exam|quiz|assess|survey|form|library)$/;
- };
-
# What can be printed is a very dynamic decision based on
# lots of factors. So we need to dynamically build this list.
# To prevent security leaks, states are only added to the wizard
- # if they can be reached, which ensures manipulating the querystring
+ # if they can be reached, which ensures manipulating the form input
# won't allow anyone to reach states they shouldn't have permission
# to reach.
- my $printChoices = [];
+
+ # printChoices is tracking the kind of printing the user can
+ # do, and will be used in a choices construction later.
+ # In the meantime we will be adding states and elements to
+ # the helper by hand.
+ my $printChoices = [];
+ my $paramHash;
# We can always print the current screen.
- push @{$printChoices}, ['current_document', "$resourceTitle (exactly what was on the screen)", 'CHOOSE_FORMAT'];
- if ($ENV{'form.postdata'}=~ /\/res\//) {
- # Allow problems from sequence
- push @{$printChoices}, ['map_problems', "Problems from $sequenceTitle", 'CHOOSE_PROBLEMS'];
- Apache::lonwizard::resource_multichoice->new($wizard, "CHOOSE_PROBLEMS", 'Select Problems', "Select problems to print from $sequenceTitle:", 'CHOOSE_FORMAT', 'RESOURCES', sub {my $res = shift; return $res->is_problem()}, undef, $map);
+ push @{$printChoices}, ["$resourceTitle (exactly what was on the screen)", 'current_document', 'FINAL'];
+ # If we're in a sequence...
+ if ($helper->{VARS}->{'postdata'} =~ /\/res\//) {
+ # Allow problems from sequence
+ push @{$printChoices}, ["Problems from $sequenceTitle", 'map_problems', 'CHOOSE_PROBLEMS'];
# Allow all resources from sequence
- push @{$printChoices}, ['map_problems_pages', "Problems and pages from $sequenceTitle", 'CHOOSE_PROBLEMS_HTML'];
- Apache::lonwizard::resource_multichoice->new($wizard, "CHOOSE_PROBLEMS_HTML", 'Select Resources', "Select resources to print from $sequenceTitle:", "CHOOSE_FORMAT", 'RESOURCES', sub {my $res = shift; return !$res->is_map()}, undef, $map);
+ push @{$printChoices}, ["Problems and pages from $sequenceTitle", 'map_problems_pages', 'CHOOSE_PROBLEMS_HTML'];
+
+ my $isProblem = '$res->is_problem();';
+ my $isProblemOrMap = '$res->is_problem() || $res->is_map()';
+ my $isNotMap = '!$res->is_map();';
+ my $symb = '$res->symb();';
+ my $helperFragment = <
+ Select problems to print:
+
+ FINAL
+ return $isProblemOrMap
+ return $isProblem
+ $map
+ return $symb
+
+
+
+
+ Select resources to print:
+
+ FINAL
+ return $isNotMap;
+ $map
+ return $symb
+
+
+HELPERFRAGMENT
+
+ &Apache::lonxml::xmlparse($r, 'helper', $helperFragment);
}
# If the user is priviledged, allow them to print all
# problems in the course, optionally for selected students
- if (($ENV{'request.role'}=~m/^cc\./ or $ENV{'request.role'}=~m/^in\./ or $ENV{'request.role'}=~m/^ta\./) and ($ENV{'form.postdata'}=~/\/res\//)) {
- push @{$printChoices}, ['all_problems', 'All problems in course (may take a lot of time)', 'CHOOSE_FORMAT'];
- push @{$printChoices}, ['problems_for_students', "Problems from $sequenceTitle for selected students", 'CHOOSE_STUDENTS'];
- Apache::lonwizard::choose_student->new($wizard, "CHOOSE_STUDENTS", "Choose Students", "Select the students you wish to print the problems for:", 'CHOOSE_FORMAT', 'STUDENTS', 1);
+ if (($ENV{'request.role'}=~m/^cc\./ or $ENV{'request.role'}=~m/^in\./ or $ENV{'request.role'}=~m/^ta\./) and ($helper->{VARS}->{'postdata'}=~/\/res\//)) {
+ push @{$printChoices}, ['All problems in course (may take a lot of time)', 'all_problems', 'ALL_PROBLEMS'];
+ push @{$printChoices}, ["Problems from $sequenceTitle for selected students", 'problems_for_students', 'CHOOSE_STUDENTS'];
+
+ my $isProblem = '$res->is_problem();';
+ my $isProblemOrMap = '$res->is_problem() || $res->is_map()';
+ my $symb = '$res->symb();';
+ &Apache::lonxml::xmlparse($r, 'helper', <
+ Select problems to print:
+
+ FINAL
+ return $isProblemOrMap
+ return $isProblem
+ return $symb
+
+
+
+
+ Select the students you wish to print the problems for:
+
+
+CHOOSE_STUDENTS
}
# FIXME: That RE should come from a library somewhere.
- if ((&Apache::lonnet::allowed('bre',$subdir) eq 'F') and ($ENV{'form.postdata'}=~/\.(problem|exam|quiz|assess|survey|form|library|page|xml|html|htm|xhtml|xhtm)/)) {
- push @{$printChoices}, ['problems_from_directory', "Problems from $subdir", 'CHOOSE_FROM_SUBDIR'];
- Apache::lonwizard::choose_files->new($wizard, "CHOOSE_FROM_SUBDIR", "Select Files","Select problems you wish to print from $subdir:", 'CHOOSE_FORMAT', 'FILES', $subdir, $problemFilter);
- }
+ if ((&Apache::lonnet::allowed('bre',$subdir) eq 'F') and ($helper->{VARS}->{'postdata'}=~/\.(problem|exam|quiz|assess|survey|form|library|page|xml|html|htm|xhtml|xhtm)/)) {
+ push @{$printChoices}, ["Problems from $subdir", 'problems_from_directory', 'CHOOSE_FROM_SUBDIR'];
+
+ my $f = '$filename';
+ &Apache::lonxml::xmlparse($r, 'helper', <
+ Select problems you wish to print from $subdir
+
+ FINAL
+ $subdir
+ return $f =~
+ m/^[^\.]+\.(problem|exam|quiz|assess|survey|form|library)$/;
+
+
+CHOOSE_FROM_SUBDIR
+ }
+
+ # Generate the first state, to select which resources get printed.
+ Apache::lonhelper::state->new("START", "Selecting Resources to Print");
+ $paramHash = Apache::lonhelper::getParamHash();
+ $paramHash->{MESSAGE_TEXT} = "What do you want to print?";
+ Apache::lonhelper::message->new();
+ $paramHash = Apache::lonhelper::getParamHash();
+ $paramHash->{'variable'} = 'PRINT_TYPE';
+ $paramHash->{CHOICES} = $printChoices;
+ Apache::lonhelper::choices->new();
+ Apache::lonprintout::page_format_state->new("FORMAT");
+
+ $helper->process();
+
+ # MANUAL BAILOUT CONDITION:
+ # If we're in the "final" state, bailout and return to handler
+ if ($helper->{STATE} eq 'FINAL') {
+ return $helper;
+ }
- # Despite the appearance of states before here, this is the first state.
- Apache::lonwizard::switch_state->new($wizard, "START", "Selecting Resources to Print", "PRINT_TYPE", $printChoices, "What do you want to print?");
- Apache::lonprintout::page_format_state->new($wizard, "CHOOSE_FORMAT", "Page Format", "FORMAT");
+ $r->print($helper->display());
- $r->print($wizard->display());
+ Apache::lonhelper::unregisterHelperTags();
untie %hash;
@@ -1391,24 +1485,31 @@ package Apache::lonprintout::page_format
=pod
-=head1 Wizard state: page_format_state
+=head1 Helper element: page_format_state
+
+See lonhelper.pm documentation for discussion of the helper framework.
-See lonwizard.pm documentation for discussion of the wizard framework.
+Apache::lonprintout::page_format_state is an element that gives the
+user an opportunity to select the page layout they wish to print
+with: Number of columns, portrait/landscape, and paper size. If you
+want to change the paper size choices, change the @paperSize array
+contents in this package.
-Apache::lonprintout::page_format_state is a state that gives the user an opportunity to select the page layout they wish to print with: Number of columns, portrait/landscape, and paper size. If you want to change the paper size choices, change the @paperSize array contents in this package.
+page_format_state is always directly invoked in lonprintout.pm, so there
+is no tag interface. You actually pass parameters to the constructor.
=over 4
-=item * B(parentLonWizReference, stateName, stateTitle, varName, nextState): varName is where the print information will be stored in the format FIXME. nextState is the state that follows this one.
+=item * B(varName): varName is where the print information will be stored in the format FIXME.
=back
=cut
-use Apache::lonwizard;
+use Apache::lonhelper;
no strict;
-@ISA = ("Apache::lonwizard::state");
+@ISA = ("Apache::lonhelper::element");
use strict;
my $maxColumns = 2;
@@ -1421,27 +1522,26 @@ my @paperSize = ("Letter [8 1/2x11 in]",
# Paper type
sub new {
- my $proto = shift;
- my $class = ref($proto) || $proto;
- my $self = bless $proto->SUPER::new(shift, shift, shift);
+ my $self = Apache::lonhelper::element->new();
+
+ shift;
- $self->{VAR_NAME} = shift;
- $self->{NEXT_STATE} = shift;
+ $self->{'variable'} = shift;
+ my $helper = Apache::lonhelper::getHelper();
+ $helper->declareVar($self->{'variable'});
+ bless($self);
return $self;
}
sub render {
my $self = shift;
- my $wizard = $self->{WIZARD};
+ my $helper = Apache::lonhelper::getHelper();
my $result = '';
- my $var = $self->{VAR_NAME};
- my $curVal = $self->{WIZARD}->{VARS}->{$var};
+ my $var = $self->{'variable'};
+ my $curVal = $helper->{VARS}->{$var};
my ($layout, $cols, $paper) = split(/\|/, $curVal);
- my $landscapeChecked = ($layout ne "L")? '' : 'checked ';
- my $portraitChecked = $landscapeChecked ? '' : 'checked ';
-
$result .= <How should the printing be formatted?
@@ -1453,8 +1553,8 @@ sub render {