Skip to content

Drop POST_HEADER_TEXT support. #1533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
drgrice1 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Drop POST_HEADER_TEXT support. #1533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 3 additions & 29 deletions lib/PGcore.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,9 @@ sub new {
#warn "creating a new PGcore object";
my %options = @_;
my $self = {
OUTPUT_ARRAY => [], # holds output body text
HEADER_ARRAY => [], # holds output for the header text
POST_HEADER_ARRAY => [],
PG_ANSWERS_HASH => {}, # holds label=>answer pairs
OUTPUT_ARRAY => [], # holds output body text
HEADER_ARRAY => [], # holds output for the header text
PG_ANSWERS_HASH => {}, # holds label=>answer pairs

# Holds other data, besides answers, which persists during a session and beyond.
PERSISTENCE_HASH => $envir->{PERSISTENCE_HASH} // {}, # Main data, received from DB
Expand Down Expand Up @@ -197,31 +196,6 @@ sub HEADER_TEXT {
$self->{HEADER_ARRAY};
}

=head2 POST_HEADER_TEXT

POST_HEADER_TEXT("string1", "string2", "string3");

POST_HEADER_TEXT() concatenates its arguments and appends them to the stored post_header
text string. It can be used more than once in a file.

The macro is used for material which is destined to be placed iimmediately after the HEAD of
the page as the first item in the body, before the main problem form
when in HTML mode, such as JavaScript code.

Spaces are placed between the arguments during concatenation, but no spaces are
introduced between the existing content of the header text string and the new
content being appended.

=cut

# ^function POST_HEADER_TEXT
# ^uses $STRINGforHEADER_TEXT
sub POST_HEADER_TEXT {
my $self = shift;
push @{ $self->{POST_HEADER_ARRAY} }, map { (defined($_)) ? $_ : '' } @_;
$self->{POST_HEADER_ARRAY};
}

=head2 TEXT

TEXT("string1", "string2", "string3");
Expand Down
48 changes: 20 additions & 28 deletions lib/WeBWorK/PG.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,16 @@ sub new_helper ($invocant, %options) {
if ($@) {
# The problem source file could not be read.
return bless {
translator => $translator,
head_text => '',
post_header_text => '',
body_text => "Unable to read problem source file:\n$@\n",
answers => {},
result => {},
state => {},
errors => 'Failed to read the problem source file.',
warnings => $warning_messages,
flags => { error_flag => 1 },
pgcore => $translator->{rh_pgcore},
translator => $translator,
head_text => '',
body_text => "Unable to read problem source file:\n$@\n",
answers => {},
result => {},
state => {},
errors => 'Failed to read the problem source file.',
warnings => $warning_messages,
flags => { error_flag => 1 },
pgcore => $translator->{rh_pgcore},
}, $class;
}
}
Expand Down Expand Up @@ -155,17 +154,16 @@ sub new_helper ($invocant, %options) {
&& (!defined $result->{summary} || $result->{summary} !~ /\S/);

return bless {
translator => $translator,
head_text => ${ $translator->r_header },
post_header_text => ${ $translator->r_post_header },
body_text => ${ $translator->r_text },
answers => $translator->rh_evaluated_answers,
result => $result,
state => $state,
errors => $translator->errors,
warnings => $warning_messages,
flags => $translator->rh_flags,
pgcore => $translator->{rh_pgcore}
translator => $translator,
head_text => ${ $translator->r_header },
body_text => ${ $translator->r_text },
answers => $translator->rh_evaluated_answers,
result => $result,
state => $state,
errors => $translator->errors,
warnings => $warning_messages,
flags => $translator->rh_flags,
pgcore => $translator->{rh_pgcore}
}, $class;
}

Expand Down Expand Up @@ -317,7 +315,6 @@ __END__
$translator = $pg->{translator}; # WeBWorK::PG::Translator
$body = $pg->{body_text}; # text string
$header = $pg->{head_text}; # text string
$post_header_text = $pg->{post_header_text}; # text string
$answerHash = $pg->{answers}; # WeBWorK::PG::AnswerHash
$result = $pg->{result}; # hash reference
$state = $pg->{state}; # hash reference
Expand Down Expand Up @@ -613,11 +610,6 @@ The WeBWorK::PG::Translator object used to render the problem.
HTML code to be injected into the E<lt>headE<gt> tag of the web page containing
the problem.

=item post_header_text

HTML code to be injected into the E<lt>bodyE<gt> tag before the form containing
the problem.

=item body_text

HTML code to be inserted into the E<lt>bodyE<gt> tag of the web page to show the
Expand Down
60 changes: 22 additions & 38 deletions lib/WeBWorK/PG/Translator.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ WeBWorK::PG::Translator - Evaluate PG code and evaluate answers safely

$PG_PROBLEM_TEXT_REF = $pt->r_text; # reference to output text for the body of problem
$PG_HEADER_TEXT_REF = $pt->r_header; # reference to text for the header in HTML output
$PG_POST_HEADER_TEXT_REF = $pt->r_post_header;
$PG_ANSWER_HASH_REF = $pt->rh_correct_answers; # a hash of answer evaluators
$PG_FLAGS_REF = $pt->rh_flags; # misc. status flags.

Expand Down Expand Up @@ -206,24 +205,23 @@ sub new {
my $safe_cmpt = exists($ENV{MOJO_MODE}) ? $WeBWorK::Translator::safeCache : WWSafe->new;

my $self = {
preprocess_code => \&default_preprocess_code,
postprocess_code => \&default_postprocess_code,
envir => undef,
PG_PROBLEM_TEXT_REF => 0,
PG_HEADER_TEXT_REF => 0,
PG_POST_HEADER_TEXT_REF => 0,
PG_ANSWER_HASH_REF => {},
PG_FLAGS_REF => {},
rh_pgcore => undef,
safe => $safe_cmpt,
safe_compartment_name => $safe_cmpt->root,
errors => '',
source => '',
rh_correct_answers => {},
rh_student_answers => {},
rh_evaluated_answers => {},
rh_problem_result => {},
rh_problem_state => {
preprocess_code => \&default_preprocess_code,
postprocess_code => \&default_postprocess_code,
envir => undef,
PG_PROBLEM_TEXT_REF => 0,
PG_HEADER_TEXT_REF => 0,
PG_ANSWER_HASH_REF => {},
PG_FLAGS_REF => {},
rh_pgcore => undef,
safe => $safe_cmpt,
safe_compartment_name => $safe_cmpt->root,
errors => '',
source => '',
rh_correct_answers => {},
rh_student_answers => {},
rh_evaluated_answers => {},
rh_problem_result => {},
rh_problem_state => {
recorded_score => 0,
num_of_correct_ans => 0,
num_of_incorrect_ans => 0,
Expand Down Expand Up @@ -426,11 +424,6 @@ sub header {
return ${ $self->{PG_HEADER_TEXT_REF} };
}

sub post_header {
my $self = shift;
return ${ $self->{PG_POST_HEADER_TEXT_REF} };
}

sub h_flags {
my $self = shift;
return %{ $self->{PG_FLAGS_REF} };
Expand All @@ -456,11 +449,6 @@ sub r_header {
return $self->{PG_HEADER_TEXT_REF};
}

sub r_post_header {
my $self = shift;
return $self->{PG_POST_HEADER_TEXT_REF};
}

sub rh_correct_answers {
my ($self, @in) = @_;
return $self->{rh_correct_answers} if @in == 0;
Expand Down Expand Up @@ -688,8 +676,6 @@ Sets the following hash keys of the translator object:
PG_PROBLEM_TEXT_REF: Reference to a string containing the rendered text.
PG_HEADER_TEXT_REF: Reference to a string containing material to be placed
in the header.
PG_POST_HEADER_TEXT_REF: Reference to a string containing material to
be placed in body above form.
rh_correct_answers: Reference to an array containing the answer evaluators.
Constructed from keys of $PGcore->{PG_ANSWERS_HASH}.
PG_FLAGS_REF: Reference to a hash containing flags and other references:
Expand Down Expand Up @@ -736,9 +722,8 @@ sub translate {
. $self->{envir}{probFileName} . '" };'
. &{ $self->{preprocess_code} }($evalString);

my ($PG_PROBLEM_TEXT_REF, $PG_HEADER_TEXT_REF, $PG_POST_HEADER_TEXT_REF, $PG_ANSWER_HASH_REF, $PG_FLAGS_REF,
$PGcore)
= $safe_cmpt->reval($evalString);
my ($PG_PROBLEM_TEXT_REF, $PG_HEADER_TEXT_REF, $PG_ANSWER_HASH_REF, $PG_FLAGS_REF, $PGcore) =
$safe_cmpt->reval($evalString);

# This section could use some more error messages. In particular if a problem doesn't produce the right output,
# the user needs information about which problem was at fault.
Expand Down Expand Up @@ -808,10 +793,9 @@ sub translate {

# Make sure that these variables are defined. If the eval failed with
# errors, one or more of these variables won't be defined.
$self->{PG_HEADER_TEXT_REF} = $PG_HEADER_TEXT_REF // \('');
$self->{PG_POST_HEADER_TEXT_REF} = $PG_POST_HEADER_TEXT_REF // \('');
$self->{rh_correct_answers} = $PG_ANSWER_HASH_REF // {};
$self->{PG_FLAGS_REF} = $PG_FLAGS_REF // {};
$self->{PG_HEADER_TEXT_REF} = $PG_HEADER_TEXT_REF // \('');
$self->{rh_correct_answers} = $PG_ANSWER_HASH_REF // {};
$self->{PG_FLAGS_REF} = $PG_FLAGS_REF // {};

$self->{rh_pgcore} = $PGcore;

Expand Down
21 changes: 3 additions & 18 deletions macros/PG.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,20 +201,6 @@ sub HEADER_TEXT {
$PG->HEADER_TEXT(@_);
}

=head2 POST_HEADER_TEXT

DEPRECATED

Content added by this method is appended just after the page head. This method
should no longer be used. There is no valid reason to add content after the
page head, and not in the problem itself.

=cut

sub POST_HEADER_TEXT {
$PG->POST_HEADER_TEXT(@_);
}

=head2 SET_PROBLEM_LANGUAGE

Valid HTML language codes are expected, but a region code or other settings may
Expand Down Expand Up @@ -1547,11 +1533,10 @@ sub ENDDOCUMENT {
$PG->{flags}{KEPT_EXTRA_ANSWERS} = \@KEPT_EXTRA_ANSWERS;
$PG->{flags}{ANSWER_ENTRY_ORDER} = \@PG_ANSWER_ENTRY_ORDER;

my $STRINGforOUTPUT = join('', @{ $PG->{OUTPUT_ARRAY} });
my $STRINGforHEADER_TEXT = join('', @{ $PG->{HEADER_ARRAY} });
my $STRINGforPOSTHEADER_TEXT = join('', @{ $PG->{POST_HEADER_ARRAY} });
my $STRINGforOUTPUT = join('', @{ $PG->{OUTPUT_ARRAY} });
my $STRINGforHEADER_TEXT = join('', @{ $PG->{HEADER_ARRAY} });

(\$STRINGforOUTPUT, \$STRINGforHEADER_TEXT, \$STRINGforPOSTHEADER_TEXT, \%PG_ANSWERS_HASH, $PG->{flags}, $PG);
(\$STRINGforOUTPUT, \$STRINGforHEADER_TEXT, \%PG_ANSWERS_HASH, $PG->{flags}, $PG);
}

sub alias {
Expand Down
9 changes: 4 additions & 5 deletions macros/core/PGbasicmacros.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2179,11 +2179,10 @@ =head2 Formatting macros
# with url specified in which case the revealed text is taken from the URL $url.
# The $display_text is always visible and is clicked to see the contents of the knowl.
iframe($url, height=>'', width=>'', id=>'', name=>'' )
# insert the web page referenced by $url in a space defined by height and width
# if the webpage contains a form then this must be inserted between
# BEGIN_POST_HEADER_TEXT/END_POST_HEADER_TEXT to avoid having one
# form(from the webpage) inside another (the defining form for the problem
A wide variety of google widgets, youtube videos, and other online resources can be imbedded using this macro. In HTML mode it creates an iframe, in TeX mode it prints the url.
Insert the web page referenced by $url in a space defined by height and width.
A wide variety of google widgets, youtube videos, and other online resources
can be embedded using this macro. In HTML mode it creates an iframe, in TeX
mode it prints the url.

helpLink($type)
Allows site specific help.
Expand Down
2 changes: 0 additions & 2 deletions t/pg_problems/problem_file.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ ok my $pg = WeBWorK::PG->new(

is($pg->{head_text}, '', 'head_text is empty');

is($pg->{post_header_text}, '', 'post_header_text is empty');

is(
$pg->{body_text},
qq{<div class="PGML">\n}
Expand Down