Skip to content

Starting a cleanup push #13

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
wants to merge 13 commits into
base: develop
Choose a base branch
from
Open

Starting a cleanup push #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f5968be
add message listener for modifying css
drdrew42 Jan 3, 2023
a52dfdc
add class manipulation and standardize behavior
drdrew42 Jan 5, 2023
4cf54c1
adjust for restructured incoming cssUpdate object
drdrew42 Jan 6, 2023
332b554
new endpoints for copy and delete from private
drdrew42 Jan 6, 2023
c2629b0
catalogue all files, not just .pg
drdrew42 Jan 10, 2023
af26884
allow sessionJWT to restore AttemptsTable
drdrew42 Mar 9, 2023
1e954d8
improve answerURL response handling
drdrew42 Apr 8, 2023
e7bb999
support postMessage "showSolutions"
drdrew42 May 9, 2023
6358737
Static file support if baseURL is nonempty
drdrew42 May 19, 2023
accb165
Convert static URLs from relative to absolute
drdrew42 May 19, 2023
3799b11
Convert all problem requests to JWT
drdrew42 May 19, 2023
381c1ff
do not require provided sourcecode to be in base64
drdrew42 May 22, 2023
3ac56a0
refactor and cleanup
drdrew42 May 22, 2023
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
30 changes: 16 additions & 14 deletions lib/RenderApp.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ sub startup {
$r->any('/render-api/cat')->to('IO#catalog');
$r->any('/render-api/find')->to('IO#search');
$r->post('/render-api/upload')->to('IO#upload');
$r->delete('/render-api/remove')->to('IO#remove');
$r->post('/render-api/clone')->to('IO#clone');
$r->post('/render-api/sma')->to('IO#findNewVersion');
$r->post('/render-api/unique')->to('IO#findUniqueSeeds');
$r->post('/render-api/tags')->to('IO#setTags');
Expand All @@ -105,20 +107,20 @@ sub startup {
$r->any('/pg_files/CAPA_Graphics/*static')->to('StaticFiles#CAPA_graphics_file');
$r->any('/pg_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 {
my $c = shift;
my $report = $c->stash('fail')."\nCOOKIE:";
for my $cookie (@{$c->req->cookies}) {
$report .= "\n".$cookie->to_string;
}
$report .= "\nFORM DATA:";
foreach my $k (@{$c->req->params->names}) {
$report .= "\n$k = ".join ', ', @{$c->req->params->every_param($k)};
}
$c->log->fatal($report);
$c->rendered(404)});
$r->any('/*fail')->to('StaticFiles#public_file');
# # any other requests fall through
# $r->any('/*fail' => sub {
# my $c = shift;
# my $report = $c->stash('fail')."\nCOOKIE:";
# for my $cookie (@{$c->req->cookies}) {
# $report .= "\n".$cookie->to_string;
# }
# $report .= "\nFORM DATA:";
# foreach my $k (@{$c->req->params->names}) {
# $report .= "\n$k = ".join ', ', @{$c->req->params->every_param($k)};
# }
# $c->log->fatal($report);
# $c->rendered(404)});
}

1;
51 changes: 28 additions & 23 deletions lib/RenderApp/Controller/FormatRenderedProblem.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ sub formatRenderedProblem {
my $problemHeadText = $rh_result->{header_text}//''; ##head_text vs header_text
my $problemPostHeaderText = $rh_result->{post_header_text}//'';
my $rh_answers = $rh_result->{answers}//{};
my $answerOrder = $rh_result->{flags}->{ANSWER_ENTRY_ORDER}; #[sort keys %{ $rh_result->{answers} }];
my $answerOrder = $rh_result->{flags}->{ANSWER_ENTRY_ORDER}//[]; #[sort keys %{ $rh_result->{answers} }];
my $encoded_source = $self->encoded_source//'';
my $sourceFilePath = $self->{sourceFilePath}//'';
my $problemSourceURL = $self->{inputs_ref}->{problemSourceURL};
Expand Down Expand Up @@ -166,9 +166,9 @@ sub formatRenderedProblem {
my $sessionJWT = $self->{return_object}{sessionJWT} // '';

my $previewMode = defined( $self->{inputs_ref}{previewAnswers} ) || 0;
my $checkMode = defined( $self->{inputs_ref}{checkAnswers} ) || 0;
my $submitMode = defined( $self->{inputs_ref}{submitAnswers} ) || 0;
# showCorrectMode needs more security -- ww2 uses want/can/will
my $showCorrectMode = defined( $self->{inputs_ref}{showCorrectAnswers} ) || 0;
my $submitMode = defined($self->{inputs_ref}{submitAnswers}) || $self->{inputs_ref}{answersSubmitted} || 0;

# problemUUID can be added to the request as a parameter. It adds a prefix
# to the identifier used by the format so that several different problems
Expand All @@ -180,6 +180,8 @@ sub formatRenderedProblem {
// $rh_result->{flags}{showPartialCorrectAnswers};
my $showSummary = $self->{inputs_ref}{showSummary} // 1; #default to show summary for the moment
my $formLanguage = $self->{inputs_ref}{language} // 'en';
my $showTable = $self->{inputs_ref}{hideAttemptsTable} ? 0 : 1;
my $showMessages = $self->{inputs_ref}{hideMessages} ? 0 : 1;
my $scoreSummary = '';

my $COURSE_LANG_AND_DIR = get_lang_and_dir($formLanguage);
Expand All @@ -191,24 +193,27 @@ sub formatRenderedProblem {
my $PROBLEM_LANG_AND_DIR = join(" ", map { qq{$_="$PROBLEM_LANG_AND_DIR{$_}"} } keys %PROBLEM_LANG_AND_DIR);
my $mt = WeBWorK::Localize::getLangHandle($self->{inputs_ref}{language} // 'en');

my $tbl = WeBWorK::Utils::AttemptsTable->new(
$rh_answers,
answersSubmitted => $self->{inputs_ref}{answersSubmitted}//0,
answerOrder => $answerOrder//[],
displayMode => $self->{inputs_ref}{displayMode},
showAnswerNumbers => 0,
showAttemptAnswers => 0,
showAttemptPreviews => ($previewMode or $submitMode or $showCorrectMode),
showAttemptResults => ($submitMode and $showPartialCorrectAnswers),
showCorrectAnswers => ($showCorrectMode),
showMessages => ($previewMode or $submitMode or $showCorrectMode),
showSummary => ( ($showSummary and ($submitMode or $showCorrectMode) )//0 )?1:0,
maketext => WeBWorK::Localize::getLoc($formLanguage//'en'),
summary => $problemResult->{summary} //'', # can be set by problem grader???
);

my $answerTemplate = $tbl->answerTemplate;
$tbl->imgGen->render(body_text => \$answerTemplate) if $tbl->displayMode eq 'images';
my $answerTemplate = '';
if ($submitMode && $showTable) {
my $tbl = WeBWorK::Utils::AttemptsTable->new(
$rh_answers,
answersSubmitted => 1,
answerOrder => $answerOrder,
displayMode => $displayMode,
showAnswerNumbers => 0,
showAttemptAnswers => 0,
showAttemptPreviews => 1,
showAttemptResults => $showPartialCorrectAnswers,
showCorrectAnswers => $showCorrectMode,
showMessages => $showMessages,
showSummary => $showSummary,
maketext => WeBWorK::Localize::getLoc($formLanguage),
summary => $problemResult->{summary} // '', # can be set by problem grader???
);

$answerTemplate = $tbl->answerTemplate;
$tbl->imgGen->render(body_text => \$answerTemplate) if $tbl->displayMode eq 'images';
}

# warn "imgGen is ", $tbl->imgGen;
#warn "answerOrder ", $tbl->answerOrder;
Expand Down Expand Up @@ -250,7 +255,7 @@ sub formatRenderedProblem {
} else {
my $url = getAssetURL($self->{inputs_ref}{language} // 'en', $_->{file});
push @{ $rh_result->{js} }, $SITE_URL.$url;
$extra_js_files .= CGI::script({ src => $url, %attributes }, '');
$extra_js_files .= CGI::script({ src => $SITE_URL.$url, %attributes }, '');
}
}
}
Expand All @@ -273,7 +278,7 @@ sub formatRenderedProblem {
} else {
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' });
$extra_css_files .= CGI::Link({ href => $SITE_URL.$url, rel => 'stylesheet' });
}
}

Expand Down
90 changes: 87 additions & 3 deletions lib/RenderApp/Controller/IO.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,91 @@ sub upload {
return $c->render( text => 'File successfully uploaded', status => 200 );
}

sub remove {
my $c = shift;
my $required = [];
push @$required,
{
field => 'removeFilePath',
checkType => 'like',
check => $regex->{privateOnly},
};
my $validatedInput = $c->validateRequest( { required => $required } );
return unless $validatedInput;

my $file_path = $validatedInput->{removeFilePath};
my $file = Mojo::File->new($file_path);

return $c->render( text => 'Path does not exist', status => 404 )
unless (-e $file);

if (-d $file) {
return $c->render( text => 'Directory is not empty', status => 400 )
unless ($file->list({ dir => 1 })->size == 0);

$file->remove_tree;
} else {
$file->remove;
}

return $c->render( text => 'Path deleted' );
}

sub clone {
my $c = shift;
my $required = [];
push @$required,
{
field => 'sourceFilePath',
checkType => 'like',
check => $regex->{privateOnly},
};
push @$required,
{
field => 'targetFilePath',
checkType => 'like',
check => $regex->{privateOnly},
};
my $validatedInput = $c->validateRequest( { required => $required } );
return unless $validatedInput;

my $source_path = $validatedInput->{sourceFilePath};
my $source_file = Mojo::File->new($source_path);
my $target_path = $validatedInput->{targetFilePath};
my $target_file = Mojo::File->new($target_path);

return $c->render( text => 'source does not exist', status => 404 )
unless (-e $source_file);

return $c->render( text => 'target already exists', status => 400 )
if (-e $target_file);

# allow cloning of directories - problems with static assets
# no recursing through directories!
if (-d $source_file) {
return $c->render( text => 'source does not contain clone-able files', status => 400)
if ($source_file->list->size == 0);

return $c->render( text => 'target must also be a directory', status => 400)
unless ($target_path =~ m!.*/$!);

$target_file->make_path;
for ($source_file->list->each) {
$_->copy_to($target_path . $_->basename);
}
} else {
return $c->render( text => 'you may not create new directories with this method', status => 400)
unless (-e $target_file->dirname);

return($c->render( text => 'file extensions do not match'))
unless ($source_file->extname eq $target_file->extname);

$source_file->copy_to($target_file);
}

return $c->render( text => 'clone successful' );
}

async sub catalog {
my $c = shift;
my $required = [];
Expand Down Expand Up @@ -169,13 +254,12 @@ sub depthSearch_p {
my $wanted = sub {
# measure depth relative to root_path
( my $rel = $File::Find::name ) =~ s!^\Q$root_path\E/?!!;
return unless $rel;
my $path = $File::Find::name;
$File::Find::prune = 1
if File::Spec::Functions::splitdir($rel) >= $depth;
$path = $path . '/' if -d $File::Find::name;
# only report .pg files and directories
$all{$rel} = $path
if ( $rel =~ /\S/ && ( $path =~ m!.+/$! || $path =~ m!.+\.pg$! ) );
$all{$rel} = $path;
};
File::Find::find { wanted => $wanted, no_chdir => 1 }, $root_path;
return \%all, 200;
Expand Down
38 changes: 24 additions & 14 deletions lib/RenderApp/Controller/Render.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ sub parseRequest {
foreach my $key (keys %$claims) {
$params{$key} //= $claims->{$key};
}
# @params{ keys %$claims } = values %$claims;
}

# problemJWT sets basic problem request configuration and rendering options
Expand All @@ -60,6 +59,17 @@ sub parseRequest {
# $claims->{problemJWT} = $problemJWT; # because we're merging claims, this is unnecessary?
# override key-values in params with those provided in the JWT
@params{ keys %$claims } = values %$claims;
} else {
# if no JWT is provided, create one
$params{aud} = $ENV{SITE_HOST};
my $req_jwt = encode_jwt(
payload => \%params,
key => $ENV{problemJWTsecret},
alg => 'PBES2-HS512+A256KW',
enc => 'A256GCM',
auto_iat => 1
);
$params{problemJWT} = $req_jwt;
}
return \%params;
}
Expand All @@ -81,7 +91,7 @@ sub fetchRemoteSource_p {
then(
sub {
my $tx = shift;
return encode_base64($tx->result->body);
return $tx->result->body;
})->
catch(
sub {
Expand Down Expand Up @@ -154,24 +164,26 @@ async sub problem {
my $response = shift->result;

$answerJWTresponse->{status} = int($response->code);
if ($response->is_success) {
# answerURL responses are expected to be JSON
if ($response->json) {
# munge data with default response object
$answerJWTresponse = { %$answerJWTresponse, %{$response->json} };
} else {
# otherwise throw the whole body as the message
$answerJWTresponse->{message} = $response->body;
}
elsif ($response->is_error) {
$answerJWTresponse->{message} = '[' . $c->logID . '] ' . $response->message;
}

$answerJWTresponse->{message} =~ s/"/\\"/g;
$answerJWTresponse->{message} =~ s/'/\'/g;
})->
catch(sub {
my $response = shift;
$c->log->error($response);
my $err = shift;
$c->log->error($err);

$answerJWTresponse->{status} = 500;
$answerJWTresponse->{message} = '[' . $c->logID . '] ' . $response;
$answerJWTresponse->{message} = '[' . $c->logID . '] ' . $err;
});

$answerJWTresponse = encode_json($answerJWTresponse);
# this will become a string literal, so single-quote characters must be escaped
$answerJWTresponse =~ s/'/\\'/g;
$c->log->info("answerJWT response ".$answerJWTresponse);

$ww_return_hash->{renderedHTML} =~ s/JWTanswerURLstatus/$answerJWTresponse/g;
Expand Down Expand Up @@ -278,7 +290,6 @@ sub jweFromRequest {
my $inputs_ref = $c->parseRequest;
return unless $inputs_ref;
$inputs_ref->{aud} = $ENV{SITE_HOST};
$inputs_ref->{key} = $ENV{problemJWTsecret};
my $req_jwt = encode_jwt(
payload => $inputs_ref,
key => $ENV{problemJWTsecret},
Expand All @@ -294,7 +305,6 @@ sub jwtFromRequest {
my $inputs_ref = $c->parseRequest;
return unless $inputs_ref;
$inputs_ref->{aud} = $ENV{SITE_HOST};
$inputs_ref->{key} = $ENV{problemJWTsecret};
my $req_jwt = encode_jwt(
payload => $inputs_ref,
key => $ENV{problemJWTsecret},
Expand Down
Loading