Skip to content

Improvements to showing the deprecated macros warning. #52

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

Merged
pstaabp merged 1 commit into from
Jun 27, 2025
Merged

Improvements to showing the deprecated macros warning. #52

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
10 changes: 5 additions & 5 deletions htdocs/js/PGProblemEditor/pgproblemeditor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,13 +514,13 @@
}
if (data.deprecated_macros?.length) {
const container = document.createElement('div');
container.classList.add('alert', 'alert-danger', 'mx-2');
container.classList.add('alert', 'alert-danger', 'mx-2', 'p-2');
container.innerHTML =
'<p>Warning!! This problem uses the following deprecated macros:</p>' +
'<ul class="mb-0">' +
'Warning!! This problem uses the following deprecated macros:' +
'<ul class="my-1">' +
data.deprecated_macros.reduce((acc, item) => `${acc}<li>${item}</li>`, '') +
'</ul><p>If this is an OPL problem, please report this issue to the OPL. ' +
'If this is a custom problem, please update the problem to use modern macros.</p>';
'</ul>If this is an OPL problem, please report this issue to the OPL. ' +
'If this is a custom problem, please update the problem to use modern macros.';
iframe.after(container);
}

Expand Down
10 changes: 5 additions & 5 deletions htdocs/js/RenderProblem/renderproblem.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,13 @@
}
if (data.deprecated_macros?.length) {
const container = document.createElement('div');
container.classList.add('alert', 'alert-danger');
container.classList.add('alert', 'alert-danger', 'p-2');
container.innerHTML =
'<p>Warning!! This problem uses the following deprecated macros:</p>' +
'<ul class="mb-0">' +
'Warning!! This problem uses the following deprecated macros:' +
'<ul class="my-1">' +
data.deprecated_macros.reduce((acc, item) => `${acc}<li>${item}</li>`, '') +
'</ul><p>If this is an OPL problem, please report this issue to the OPL. ' +
'If this is a custom problem, please update the problem to use modern macros.</p>';
'</ul>If this is an OPL problem, please report this issue to the OPL. ' +
'If this is a custom problem, please update the problem to use modern macros.';
iframe.after(container);
}
iFrameResize(
Expand Down
19 changes: 10 additions & 9 deletions lib/WeBWorK/Utils/Rendering.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,19 +253,12 @@ sub renderPG ($c, $effectiveUser, $set, $problem, $psvn, $formFields, $translati
flags => $pg->{flags},
};

# get a list of the deprecated macros
my @deprecated_macros;
for (keys %{ $pg->{pgcore}{PG_loadMacros}{macroFileList} }) {
my @dirs = split('/', $_);
push(@deprecated_macros, $dirs[-1]) if $dirs[-2] eq 'deprecated';
}

if (ref($pg->{pgcore}) eq 'PGcore') {
$ret->{internal_debug_messages} = $pg->{pgcore}->get_internal_debug_messages;
$ret->{warning_messages} = $pg->{pgcore}->get_warning_messages();
$ret->{debug_messages} = $pg->{pgcore}->get_debug_messages();
$ret->{deprecated_macros} = \@deprecated_macros;
$ret->{PG_ANSWERS_HASH} = {

$ret->{PG_ANSWERS_HASH} = {
map {
$_ => {
response_obj => unbless($pg->{pgcore}{PG_ANSWERS_HASH}{$_}->response_obj),
Expand All @@ -279,6 +272,14 @@ sub renderPG ($c, $effectiveUser, $set, $problem, $psvn, $formFields, $translati
keys %{ $pg->{pgcore}{PG_alias}{resource_list} }
};
$ret->{PERSISTENCE_HASH} = $pg->{pgcore}{PERSISTENCE_HASH};

# Get a list of the deprecated macros used in the problem.
my @deprecated_macros;
for (keys %{ $pg->{pgcore}{PG_loadMacros}{macroFileList} }) {
my @dirs = split('/', $_);
push(@deprecated_macros, $dirs[-1]) if $dirs[-2] eq 'deprecated';
}
$ret->{deprecated_macros} = \@deprecated_macros;
}

# Save the problem source. This is used by Caliper::Entity. Why?
Expand Down