Update permissions for viewing info on ProblemSet page.

Rework when a user is able to see set information on the ProblemSet
page. This includes being able to see the set description and
information header before a set is open.

The goal is to make the ProblemSet page friendlier when a student
accesses it from an LMS before the open date or if the set is not
currently visible. In addition the set headers can be used to
provide information to students before the set opens.

This is done by adding a new permission `view_unoppend_set_info`
which defaults to `guest` (this allows instructors to change this to
`ta` to get the old behavior). Users with this permission will be
shown a ProblemSet page that includes when the set opens along with
the set information header and a button to email the instructor
before the open date. In addition users with this permission
will be shown a warning alert instead of a danger alert if they
try to access a hidden set (the set header will not be included
in this case).

Note, that the permission `view_unoppend_sets` description in
the course configuration is just being able to view problems
on sets which are not open, so this new permission is consistent
with the previous description, it just separates seeing set info
from seeing set problems.

Care is taken to ensure that students can view (thus access)
any existing test versions for tests that have ip restrictions,
or if the template open date was changed.

Only show the right info panel div on the ProblemSet page when
the set header exists and the user has permissions to see it.

Translations were added to messages about IP restrictions.

Author: somiaj

conf/defaults.config

@@ -751,6 +751,7 @@ $authen{admin_module} = ['WeBWorK::Authen::Basic_TheLastOption'];
 	view_proctored_tests           => "student",
 	view_hidden_work               => "ta",
 
+	view_unopened_set_info         => "guest",
 	view_multiple_sets             => "ta",
 	view_unopened_sets             => "ta",
 	view_hidden_sets               => "ta",

lib/WeBWorK/Authz.pm

@@ -415,25 +415,27 @@ sub checkSet {
 	$self->{merged_set} = $set;
 
 	# Now we know that the set is assigned to the appropriate user.
-	# Check to see if the user is trying to access a set that is not open.
-	if (
-		before($set->open_date)
-		&& !$self->hasPermissions($userName, "view_unopened_sets")
-		&& !(
-			defined $set->assignment_type
-			&& $set->assignment_type =~ /gateway/
-			&& $node_name eq 'problem_list'
-			&& $db->countSetVersions($effectiveUserName, $set->set_id)
-		)
-		)
-	{
-		return $c->maketext("Requested set '[_1]' is not yet open.", $setName);
-	}
-
 	# Check to make sure that the set is visible, and that the user is allowed to view hidden sets.
+	# If the user can view unopened set information, they will be given warning messages vs error message.
 	my $visible = $set && $set->visible ne '0' && $set->visible ne '1' ? 1 : $set->visible;
 	if (!$visible && !$self->hasPermissions($userName, "view_hidden_sets")) {
-		return $c->maketext("Requested set '[_1]' is not available yet.", $setName);
+		$c->{viewSetCheck} = 'hidden'
+			if $node_name eq 'problem_list' && $self->hasPermissions($userName, 'view_unopened_set_info');
+		return $c->maketext("Requested set '[_1]' is not available.", $setName);
+	}
+
+	# Check to see if the user is trying to access a set that is not open.
+	if (before($set->open_date) && !$self->hasPermissions($userName, 'view_unopened_sets')) {
+		# Show problem set info if user has permissions, or there exists any test versions.
+		$c->{viewSetCheck} = 'unopened'
+			if $node_name eq 'problem_list'
+			&& (
+				$self->hasPermissions($userName, 'view_unopened_set_info')
+				|| (defined $set->assignment_type
+					&& $set->assignment_type =~ /gateway/
+					&& $db->countSetVersions($effectiveUserName, $set->set_id))
+			);
+		return $c->maketext("Requested set '[_1]' is not yet open.", $setName);
 	}
 
 	# Check to see if conditional release conditions have been met.
@@ -474,7 +476,11 @@ sub checkSet {
 
 	# Check for ip restrictions.
 	my $badIP = $self->invalidIPAddress($set);
-	return $badIP if $badIP;
+	if ($badIP) {
+		# Allow viewing of set info of restricted sets.
+		$c->{viewSetCheck} = 'restricted' if $node_name eq 'problem_list';
+		return $badIP;
+	}
 
 	# If LTI grade passback is enabled and set to 'homework' mode then we need to make sure that there is a sourcedid
 	# for this set before students access it.
@@ -530,7 +536,9 @@ sub invalidIPAddress {
 	# if there are no addresses in the locations, return an error that
 	#    says this
 	return $c->maketext(
-		"Client ip address [_1] is not allowed to work this assignment, because the assignment has ip address restrictions and there are no allowed locations associated with the restriction.  Contact your professor to have this problem resolved.",
+		'Client ip address [_1] is not allowed to work this assignment, because the assignment has ip address '
+			. 'restrictions and there are no allowed locations associated with the restriction.  Contact your '
+			. 'professor to have this problem resolved.',
 		$clientIP->ip()
 	) if (!@restrictAddresses);
 
@@ -552,17 +560,13 @@ sub invalidIPAddress {
 	# this is slightly complicated by having to check relax_restrict_ip
 	my $badIP = '';
 	if ($restrictType eq 'RestrictTo' && !$inRestrict) {
-		$badIP =
-			"Client ip address "
-			. $clientIP->ip()
-			. " is not in the list of addresses from "
-			. "which this assignment may be worked.";
+		$badIP = $c->maketext(
+			'Client ip address [_1] is not in the list of addresses from which this assignment may be worked.',
+			$clientIP->ip());
 	} elsif ($restrictType eq 'DenyFrom' && $inRestrict) {
-		$badIP =
-			"Client ip address "
-			. $clientIP->ip()
-			. " is in the list of addresses from "
-			. "which this assignment may not be worked.";
+		$badIP = $c->maketext(
+			'Client ip address [_1] is in the list of addresses from which this assignment may not be worked.',
+			$clientIP->ip());
 	} else {
 		return 0;
 	}

lib/WeBWorK/ConfigValues.pm

@@ -590,6 +590,15 @@ sub getConfigValues ($ce) {
 				doc2 => x('These users and higher get the "Show Past Answers" button on the problem page.'),
 				type => 'permission'
 			},
+			{
+				var  => 'permissionLevels{view_unopened_set_info}',
+				doc  => x('Allowed to view set information for sets which are not open yet'),
+				doc2 => x(
+					'This includes being able to see the set description attached to the links on the assignments '
+						. 'page, and seeing the set header on the set information page.'
+				),
+				type => 'permission'
+			},
 			{
 				var  => 'permissionLevels{view_unopened_sets}',
 				doc  => x('Allowed to view problems in sets which are not open yet'),

lib/WeBWorK/ContentGenerator.pm

@@ -110,8 +110,6 @@ async sub go ($c) {
 
 	my $tx = $c->render_later->tx;
 
-	$c->stash->{footerWidthClass} = $c->can('info') ? 'col-md-8' : 'col-12';
-
 	if ($c->can('pre_header_initialize')) {
 		my $pre_header_initialize = $c->pre_header_initialize;
 		await $pre_header_initialize
@@ -133,6 +131,8 @@ async sub go ($c) {
 		await $initialize if ref $initialize eq 'Future' || ref $initialize eq 'Mojo::Promise';
 	}
 
+	$c->stash->{footerWidthClass} //= $c->can('info') ? 'col-md-8' : 'col-12';
+
 	$c->content;
 
 	# All content generator modules must have rendered at this point unless there was an error in which case an error

lib/WeBWorK/ContentGenerator/ProblemSet.pm

@@ -18,18 +18,23 @@ use WeBWorK::DB::Utils        qw(grok_versionID_from_vsetID_sql);
 use WeBWorK::Localize;
 use WeBWorK::AchievementItems;
 
+sub can ($c, $arg) {
+	if ($arg eq 'info') {
+		return $c->{pg} ? 1 : 0;
+	}
+	return $c->SUPER::can($arg);
+}
+
 async sub initialize ($c) {
 	my $db    = $c->db;
 	my $ce    = $c->ce;
 	my $authz = $c->authz;
 
-	# $c->{invalidSet} is set in checkSet which is called by ContentGenerator.pm
-	return
-		if $c->{invalidSet}
-		&& ($c->{invalidSet} !~ /^Client ip address .* is not in the list of addresses/
-			|| $authz->{merged_set}->assignment_type !~ /gateway/);
+	# $c->{invalidSet} is set in checkSet which is called by ContentGenerator.pm.
+	# If $c->{viewSetCheck} is also set, we want to view some information unless the set is hidden.
+	return if $c->{invalidSet} && (!$c->{viewSetCheck} || $c->{viewSetCheck} eq 'hidden');
 
-	# This will all be valid if checkSet did not set $c->{invalidSet}.
+	# This will all be valid if the above check passes.
 	my $userID  = $c->param('user');
 	my $eUserID = $c->param('effectiveUser');
 
@@ -161,9 +166,7 @@ sub siblings ($c) {
 	return $c->include('ContentGenerator/ProblemSet/siblings', setIDs => \@setIDs);
 }
 
-sub info {
-	my ($c) = @_;
-	return '' unless $c->{pg};
+sub info ($c) {
 	return $c->include('ContentGenerator/ProblemSet/info');
 }
 

lib/WeBWorK/ContentGenerator/ProblemSets.pm

@@ -118,7 +118,7 @@ sub getSetStatus ($c, $set) {
 	my $db              = $c->db;
 	my $authz           = $c->authz;
 	my $effectiveUser   = $c->param('effectiveUser') || $c->param('user');
-	my $canViewUnopened = $authz->hasPermissions($c->param('user'), 'view_unopened_sets');
+	my $canViewUnopened = $authz->hasPermissions($c->param('user'), 'view_unopened_set_info');
 
 	my @restricted = $ce->{options}{enableConditionalRelease} ? is_restricted($db, $set, $effectiveUser) : ();
 
@@ -134,6 +134,7 @@ sub getSetStatus ($c, $set) {
 			$c->maketext('Will open on [_1].', $c->formatDateTime($set->open_date, $ce->{studentDateDisplayFormat}));
 		push(@$other_messages, $c->restricted_progression_msg(1, $set->restricted_status * 100, @restricted))
 			if @restricted;
+		# Test versions are only available on the ProblemSet page, so allow access if there are any test versions.
 		$link_is_active = 0
 			unless $canViewUnopened
 			|| ($set->assignment_type =~ /gateway/ && $db->countSetVersions($effectiveUser, $set->set_id));

templates/ContentGenerator/ProblemSet.html.ep

@@ -1,28 +1,44 @@
 % use WeBWorK::Utils::DateTime qw(before between);
 %
-% if (
-	% $c->{invalidSet}
-	% && ($c->{invalidSet} !~ /^Client ip address .* is not in the list of addresses/
-		% || $authz->{merged_set}->assignment_type !~ /gateway/)
-	% )
-% {
-	<div class="alert alert-danger">
-		<p class="mb-3">
-			<%= maketext(
-				'The selected problem set ([_1]) is not a valid set for [_2].',
-				stash('setID'), param('effectiveUser')
-			) =%>
-		</p>
-		<p class="mb-0"><%= $c->{invalidSet} %></p>
-	</div>
-	% last;
+% if ($c->{invalidSet}) {
+	% # If $c->{viewSetCheck} is set, show some set information.
+	% if ($c->{viewSetCheck}) {
+		% # Do nothing unless the set is hidden, then show a warning message instead of an error.
+		% if ($c->{viewSetCheck} eq 'hidden') {
+			<div class="alert alert-warning">
+				<p class="mb-0"><%= $c->{invalidSet} %></p>
+			</div>
+			% last;
+		% }
+	% } else {
+		<div class="alert alert-danger">
+			<p class="mb-3">
+				<%= maketext(
+					'The selected problem set ([_1]) is not a valid set for [_2].',
+					stash('setID'), param('effectiveUser')
+				) =%>
+			</p>
+			<p class="mb-0"><%= $c->{invalidSet} %></p>
+		</div>
+		% last;
+	% }
 % }
 %
 % my $set = $c->{set};
 %
 % # Stats message displays the current status of the set and states the next important date.
 <%= include 'ContentGenerator/Base/set_status', set => $set =%>
 %
+% # Shows warning about restricted IP settings.
+% if ($c->{viewSetCheck} && $c->{viewSetCheck} eq 'restricted') {
+	<div class="alert alert-warning"><%= $c->{invalidSet} %></div>
+% }
+%
 <%= include 'ContentGenerator/ProblemSet/auxiliary_tools' =%>
 %
-<%= $set->assignment_type =~ /gateway/ ? $c->gateway_body : $c->problem_list =%>
+% # Always show test versions, but only show problem list if the set has no restrictions.
+% if ($set->assignment_type =~ /gateway/) {
+	<%= $c->gateway_body =%>
+% } elsif (!$c->{viewSetCheck}) {
+	<%= $c->problem_list =%>
+% }

templates/ContentGenerator/ProblemSet/auxiliary_tools.html.ep

@@ -11,6 +11,11 @@
 			showSolutions      => '',
 		) =%>
 	</div>
+	% # If viewing a restricted set, don't show anymore buttons.
+	% if ($c->{viewSetCheck}) {
+		</div>
+		% last;
+	% }
 	% if ($ce->{achievementsEnabled} && $ce->{achievementItemsEnabled}) {
 		% my $achievementItems = $c->{achievementItems};
 		% if ($achievementItems && @$achievementItems) {

templates/ContentGenerator/ProblemSet/version_list.html.ep

@@ -8,11 +8,8 @@
 %
 % my $routeName = $set->assignment_type =~ /proctored/ ? 'proctored_gateway_quiz' : 'gateway_quiz';
 %
-% if ($c->{invalidSet}) {
-	% # If this is an invalidSet it is because the IP address is not allowed to access the set.
-	% # Display that message here.  Note that the set is valid so the set versions can still be displayed,
-	% # but the "Start New Test" or "Continue Test" buttons should not be.
-	<div class="alert alert-warning"><%= $c->{invalidSet} %></div>
+% if ($c->{viewSetCheck}) {
+	% # If we are viewing a restricted set, then only show existing set versions and no other information.
 % } elsif ($continueVersion) {
 	% # Display information about the current test and a continue open test button.
 	% if ($timeLimit > 0) {
@@ -249,6 +246,6 @@
 	% } else {
 		<%= $version_list->() =%>
 	% }
-% } else {
+% } elsif (!$c->{viewSetCheck}) {
 	<div><p><%= maketext('No versions of this test have been taken.') %></p></div>
 % }