Update the renderer to use getAssetsUrl and the current develop branch

(or PG-2.17 branch) of PG.

Author: drgrice1

.gitignore

@@ -3,11 +3,10 @@ render_app.conf
 lib/WeBWorK/htdocs/tmp/renderer/gif/*
 lib/WeBWorK/htdocs/tmp/renderer/images/*
 lib/WeBWorK/htdocs/DATA/*.json
-lib/WeBWorK/htdocs/js/apps/Problem/problem.css
 lib/WeBWorK/bin/*
 webwork-open-problem-library/
 private/
-tmp/
+tmp/*
 logs/*.log
 node_modules
 node_modules/*

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "lib/PG"]
 	path = lib/PG
-	url = https://github.com/drgrice1/pg.git
-	branch = ww3-rendering-work-new
+	url = https://github.com/openwebwork/pg.git
+	branch = main

lib/PG

@@ -5,15 +5,18 @@ BEGIN {
     use Mojo::File;
     $main::dirname = Mojo::File::curfile->dirname;
 
-    #RENDER_ROOT is required for initializing conf files
+    # RENDER_ROOT is required for initializing conf files.
     $ENV{RENDER_ROOT} = $main::dirname->dirname
       unless ( defined( $ENV{RENDER_ROOT} ) );
 
-    #WEBWORK_ROOT is required for PG/lib/WeBWorK/IO
-    $ENV{WEBWORK_ROOT} = $main::dirname . '/WeBWorK'
-      unless ( defined( $ENV{WEBWORK_ROOT} ) );
+    # WEBWORK_ROOT is required for PG/lib/WeBWorK/IO.
+    # PG_ROOT is required for PG/lib/PGEnvironment.pm.
+    # These are hardcoded to avoid conflict with environment variables for webwork2.
+    # There is no need for these to be configurable.
+    $ENV{WEBWORK_ROOT} = $main::dirname . '/WeBWorK';
+    $ENV{PG_ROOT} = $main::dirname . '/PG';
 
-    #used for reconstructing library paths from sym-links
+    # Used for reconstructing library paths from sym-links.
     $ENV{OPL_DIRECTORY}                    = "webwork-open-problem-library";
     $WeBWorK::Constants::WEBWORK_DIRECTORY = $main::dirname . "/WeBWorK";
     $WeBWorK::Constants::PG_DIRECTORY      = $main::dirname . "/PG";
@@ -60,7 +63,7 @@ sub startup {
 
 	# Handle optional CORS settings
 	if (my $CORS_ORIGIN = $self->config('CORS_ORIGIN')) {
-		die "CORS_ORIGIN ($CORS_ORIGIN) must be an absolute URL or '*'" 
+		die "CORS_ORIGIN ($CORS_ORIGIN) must be an absolute URL or '*'"
 			unless ($CORS_ORIGIN eq '*' || $CORS_ORIGIN =~ /^https?:\/\//);
 
 		$self->hook(before_dispatch => sub {
@@ -108,35 +111,10 @@ sub startup {
 		$r->post('/render-api/tags')->to('IO#setTags');
 	}
 
-	# Route requests for webwork2_files/CAPA_Graphics to render root Contrib/CAPA/CAPA_Graphics
-	$r->any(
-		'/webwork2_files/CAPA_Graphics/*static' => sub {
-			my $c = shift;
-			$c->reply->file("$ENV{RENDER_ROOT}/Contrib/CAPA/CAPA_Graphics/" . $c->stash('static'));
-		}
-	);
-
-	# Route requests for webwork2_files/tmp to the render root tmp
-	# This should really be configurable.
-	$r->any(
-		'/webwork2_files/tmp/*static' => sub {
-			my $c = shift;
-			$c->reply->file("$ENV{RENDER_ROOT}/tmp/" . $c->stash('static'));
-		}
-	);
-
-	# Route requests to webwork2_files to lib/WeBWorK/htdocs if the requested file exists there,
-	# otherwise route them to lib/PG/htdocs.
-	$r->any(
-		'/webwork2_files/*static' => sub {
-			my $c = shift;
-			if (-e "$WeBWorK::Constants::WEBWORK_DIRECTORY/htdocs/" . $c->stash('static')) {
-				$c->reply->file("$WeBWorK::Constants::WEBWORK_DIRECTORY/htdocs/" . $c->stash('static'));
-			} else {
-				$c->reply->file("$WeBWorK::Constants::PG_DIRECTORY/htdocs/" . $c->stash('static'));
-			}
-		}
-	);
+	# Static file routes
+	$r->any('/webwork2_files/CAPA_Graphics/*static')->to('StaticFiles#CAPA_graphics_file');
+	$r->any('/webwork2_files/tmp/*static')->to('StaticFiles#temp_file');
+	$r->any('/pg_files/*static')->to('StaticFiles#pg_file');
 
 	# any other requests fall through
 	$r->any('/*fail' => sub {

lib/RenderApp.pm

@@ -24,13 +24,16 @@ FormatRenderedProblem.pm
 
 package RenderApp::Controller::FormatRenderedProblem;
 
+use warnings;
+use strict;
+
 use lib "$WeBWorK::Constants::WEBWORK_DIRECTORY/lib";
 use lib "$WeBWorK::Constants::PG_DIRECTORY/lib";
 use MIME::Base64 qw( encode_base64 decode_base64);
 use WeBWorK::Utils::AttemptsTable; #import from ww2
 use WeBWorK::PG::ImageGenerator; # import from ww2
 use WeBWorK::Utils::LanguageAndDirection;
-use WeBWorK::Utils qw( wwRound);   # required for score summary
+use WeBWorK::Utils qw(wwRound getAssetURL);   # required for score summary
 use WeBWorK::Localize ; # for maketext
 our $UNIT_TESTS_ON  = 0;
 
@@ -46,7 +49,7 @@ sub format_hash_ref {
 sub new {
   my $invocant = shift;
   my $class = ref $invocant || $invocant;
-	$self = { # Is this function redundant given the declarations within sub formatRenderedProblem?
+  my $self = { # Is this function redundant given the declarations within sub formatRenderedProblem?
 		return_object => {},
 		encoded_source => {},
 		sourceFilePath => '',
@@ -199,7 +202,7 @@ sub formatRenderedProblem {
 		answersSubmitted       => $self->{inputs_ref}{answersSubmitted}//0,
 		answerOrder            => $answerOrder//[],
 		displayMode            => $self->{inputs_ref}{displayMode},
-		imgGen                 => $imgGen,
+		imgGen                 => undef, # $imgGen,
 		ce                     => '',	#used only to build the imgGen
 		showAnswerNumbers      => 0,
 		showAttemptAnswers     => 0,
@@ -242,39 +245,33 @@ sub formatRenderedProblem {
 
 	# Add JS files requested by problems via ADD_JS_FILE() in the PG file.
 	my $extra_js_files = '';
-	if (ref($rh_result->{flags}{extra_js_files}) eq "ARRAY") {
+	if (ref($rh_result->{flags}{extra_js_files}) eq 'ARRAY') {
 		$rh_result->{js} = [];
 		my %jsFiles;
 		for (@{ $rh_result->{flags}{extra_js_files} }) {
 			next if $jsFiles{ $_->{file} };
 			$jsFiles{ $_->{file} } = 1;
-			my $attributes = ref($_->{attributes}) eq "HASH" ? $_->{attributes} : {};
+			my %attributes = ref($_->{attributes}) eq 'HASH' ? %{ $_->{attributes} } : ();
 			if ($_->{external}) {
 				push @{ $rh_result->{js} }, $_->{file};
-				$extra_js_files .= CGI::script({ src => $_->{file}, %$attributes }, '');
-			} elsif (
-				!$_->{external}
-				&& (-f "$WeBWorK::Constants::WEBWORK_DIRECTORY/htdocs/$_->{file}"
-					|| -f "$WeBWorK::Constants::PG_DIRECTORY/htdocs/$_->{file}")
-				)
-			{
-				push @{ $rh_result->{js} }, "$webwork_htdocs_url/$_->{file}";
-				$extra_js_files .= CGI::script({ src => "$webwork_htdocs_url/$_->{file}", %$attributes }, '');
+				$extra_js_files .= CGI::script({ src => $_->{file}, %attributes }, '');
 			} else {
-				$extra_js_files .= "<!-- $_->{file} is not available in htdocs/ on this server -->";
+				my $url = getAssetURL($self->{inputs_ref}{language} // 'en', $_->{file});
+				push @{ $rh_result->{js} }, "$SITE_URL/$url";
+				$extra_js_files .= CGI::script({ src => $url, %attributes }, '');
 			}
 		}
 	}
 
 	# Add CSS files requested by problems via ADD_CSS_FILE() in the PG file
-	# or via a setting of $ce->{pg}{specialPGEnvironmentVars}{extra_css_files}
+	# or via a setting of $self->{ce}{pg}{specialPGEnvironmentVars}{extra_css_files}
 	# (the value should be an anonomous array).
 	my $extra_css_files = '';
 	my @cssFiles;
-	if (ref($ce->{pg}{specialPGEnvironmentVars}{extra_css_files}) eq "ARRAY") {
-		push(@cssFiles, { file => $_, external => 0 }) for @{ $ce->{pg}{specialPGEnvironmentVars}{extra_css_files} };
+	if (ref($self->{ce}{pg}{specialPGEnvironmentVars}{extra_css_files}) eq 'ARRAY') {
+		push(@cssFiles, { file => $_, external => 0 }) for @{ $self->{ce}{pg}{specialPGEnvironmentVars}{extra_css_files} };
 	}
-	if (ref($rh_result->{flags}{extra_css_files}) eq "ARRAY") {
+	if (ref($rh_result->{flags}{extra_css_files}) eq 'ARRAY') {
 		push @cssFiles, @{ $rh_result->{flags}{extra_css_files} };
 	}
 	my %cssFilesAdded;    # Used to avoid duplicates
@@ -284,17 +281,11 @@ sub formatRenderedProblem {
 		$cssFilesAdded{ $_->{file} } = 1;
 		if ($_->{external}) {
 			push @{ $rh_result->{css} }, $_->{file};
-			$extra_css_files .= CGI::Link({ rel => 'stylesheet', href => "$_->{file}" });
-		} elsif (
-			!$_->{external}
-			&& (-f "$WeBWorK::Constants::WEBWORK_DIRECTORY/htdocs/$_->{file}"
-				|| -f "$WeBWorK::Constants::PG_DIRECTORY/htdocs/$_->{file}")
-			)
-		{
-			push @{ $rh_result->{css} }, "$webwork_htdocs_url/$_->{file}";
-			$extra_css_files .= CGI::Link({ rel => 'stylesheet', href => "$webwork_htdocs_url/$_->{file}" });
+			$extra_css_files .= CGI::Link({ rel => 'stylesheet', href => $_->{file} });
 		} else {
-			$extra_css_files .= qq{<!-- $_->{file} is not available in htdocs/ on this server -->};
+			my $url = getAssetURL($self->{inputs_ref}{language} // 'en', $_->{file});
+			push @{ $rh_result->{css} }, "$SITE_URL/$url";
+			$extra_css_files .= CGI::Link({ href => $url, rel => 'stylesheet' });
 		}
 	}
 

lib/RenderApp/Controller/FormatRenderedProblem.pm

@@ -368,7 +368,7 @@ sub standaloneRenderer {
         refreshMath2img => 1,
         processAnswers  => $processAnswers,
         QUIZ_PREFIX     => $inputs_ref->{answerPrefix} // '',
-        useMathQuill    => 1,
+		useMathQuill    => !defined $inputs_ref->{entryAssist} || $inputs_ref->{entryAssist} eq 'MathQuill' ? 1 : 0,
 
         #use_site_prefix 	=> 'http://localhost:3000',
         use_opaque_prefix        => 0,

lib/RenderApp/Controller/RenderProblem.pm

@@ -0,0 +1,31 @@
+package RenderApp::Controller::StaticFiles;
+use Mojo::Base 'Mojolicious::Controller', -signatures;
+
+use Mojo::File qw(path);
+
+sub reply_with_file_if_readable ($c, $file) {
+	if (-r $file) {
+		return $c->reply->file($file);
+	} else {
+		return $c->render(data => 'File not found', status => 404);
+	}
+}
+
+# Route requests for webwork2_files/CAPA_Graphics to render root Contrib/CAPA/CAPA_Graphics
+sub CAPA_graphics_file ($c) {
+	return $c->reply_with_file_if_readable($c->app->home->child('Contrib/CAPA/CAPA_Graphics', $c->stash('static')));
+}
+
+# Route requests for webwork2_files to the render root tmp.  The
+# only requests should be for files in the temporary directory.
+# FIXME: Perhaps this directory should be configurable.
+sub temp_file ($c) {
+	$c->reply_with_file_if_readable($c->app->home->child('tmp', $c->stash('static')));
+}
+
+# Route request to pg_files to lib/PG/htdocs.
+sub pg_file ($c) {
+	$c->reply_with_file_if_readable(path($WeBWorK::Constants::PG_DIRECTORY, 'htdocs', $c->stash('static')));
+}
+
+1;