WIP: work on course settings

Author: pstaabp

lib/DB/Schema/Result/CourseSetting.pm

@@ -25,14 +25,16 @@ C<setting_id>: database id that the given setting is related to (foreign key)
 
 =item *
 
-C<value>: the value of the setting
+C<value>: the value of the setting as a JSON so different types of data can be stored.
 
 =back
 
 =cut
 
 __PACKAGE__->table('course_setting');
 
+__PACKAGE__->load_components('InflateColumn::Serializer', 'Core');
+
 __PACKAGE__->add_columns(
 	course_setting_id => {
 		data_type         => 'integer',
@@ -51,8 +53,11 @@ __PACKAGE__->add_columns(
 		is_nullable => 0,
 	},
 	value => {
-		data_type   => 'text',
-		is_nullable => 0,
+		data_type          => 'text',
+		is_nullable        => 0,
+		default_value      => '\'\'',
+		serializer_class   => 'JSON',
+		serializer_options => { utf8 => 1 }
 	},
 );
 

lib/DB/Schema/Result/GlobalSetting.pm

@@ -80,8 +80,8 @@ __PACKAGE__->add_columns(
 		default_value => '',
 	},
 	doc => {
-		data_type     => 'text',
-		is_nullable   => 1,
+		data_type   => 'text',
+		is_nullable => 1,
 	},
 	type => {
 		data_type     => 'varchar',
@@ -102,9 +102,9 @@ __PACKAGE__->add_columns(
 		default_value => ''
 	},
 	subcategory => {
-		data_type     => 'varchar',
-		size          => 64,
-		is_nullable   => 1
+		data_type   => 'varchar',
+		size        => 64,
+		is_nullable => 1
 	}
 );
 

lib/DB/Schema/ResultSet/Course.pm

@@ -356,18 +356,19 @@ sub getCourseSettings ($self, %args) {
 	my @settings_from_db = $course->course_settings;
 
 	return \@settings_from_db if $args{as_result_set};
-	my @settings_to_return;
-	if ($args{merged}) {
-		@settings_to_return = map {
+	my @settings_to_return = ($args{merged})
+		? map {
 			{ $_->get_inflated_columns, $_->global_setting->get_inflated_columns };
-		} @settings_from_db;
-		for my $setting (@settings_to_return) {
-			$setting->{default_value} = $setting->{default_value}->{value};
-		}
-	} else {
-		@settings_to_return = map {
+		} @settings_from_db
+		: map {
 			{ $_->get_inflated_columns };
 		} @settings_from_db;
+
+	for my $setting (@settings_to_return) {
+		# value and default_value are decoded from JSON as a hash.  Return to a value.
+		for my $key (qw/default_value value/) {
+			$setting->{$key} = $setting->{$key}->{value} if defined($setting->{$key});
+		}
 	}
 	return \@settings_to_return;
 }
@@ -409,13 +410,16 @@ sub getCourseSetting ($self, %args) {
 	my $setting = $course->course_settings->find({ setting_id => $global_setting->setting_id });
 
 	return $setting if $args{as_result_set};
-	if ($args{merged}) {
-		my $setting_to_return = { $setting->get_inflated_columns, $setting->global_setting->get_inflated_columns };
-		$setting_to_return->{default_value} = $setting_to_return->{default_value}->{value};
-		return $setting_to_return;
-	} else {
-		return { $setting->get_inflated_columns };
+	my $setting_to_return =
+		$args{merged}
+		? { $setting->get_inflated_columns, $setting->global_setting->get_inflated_columns }
+		: { $setting->get_inflated_columns };
+
+	# value and default_value are decoded from JSON as a hash.  Return to a value.
+	for my $key (qw/default_value value/) {
+		$setting_to_return->{$key} = $setting_to_return->{$key}->{value} if defined($setting_to_return->{$key});
 	}
+	return $setting_to_return;
 }
 
 =pod
@@ -445,7 +449,9 @@ global setting.
 A single course setting as either a hashref or a C<DBIx::Class::ResultSet::CourseSetting> object.
 
 =cut
+
 use Data::Dumper;
+
 sub updateCourseSetting ($self, %args) {
 	my $course = $self->getCourse(info => getCourseInfo($args{info}), as_result_set => 1);
 
@@ -460,32 +466,32 @@ sub updateCourseSetting ($self, %args) {
 	my $params = {
 		course_id  => $course->course_id,
 		setting_id => $global_setting->{setting_id},
-		value      => $args{params}->{value}
+		value      => { value => $args{params}->{value} }
 	};
 
 	# remove the following fields before checking for valid settings:
 	for (qw/setting_id course_id/) { delete $global_setting->{$_}; }
 
-	isValidSetting($global_setting, $params->{value});
+	isValidSetting($global_setting, $params->{value}->{value});
 
 	# The course_id must be deleted to ensure it is written to the database correctly.
 	delete $params->{course_id} if defined($params->{course_id});
 
-	my $updated_course_setting = defined($course_setting) ? $course_setting->update($params) : $course->add_to_course_settings($params);
-
-	if ($args{merged}) {
-		my $setting_to_return = {
-			$updated_course_setting->get_inflated_columns,
-			$updated_course_setting->global_setting->get_inflated_columns
-		};
-		$setting_to_return->{default_value} = $setting_to_return->{default_value}->{value};
-		return $setting_to_return;
-	} else {
-		return { $updated_course_setting->get_inflated_columns };
-	}
+	my $updated_course_setting =
+		defined($course_setting) ? $course_setting->update($params) : $course->add_to_course_settings($params);
 
+	return $updated_course_setting if $args{as_result_set};
+	my $setting_to_return =
+		($args{merged})
+		? { $updated_course_setting->get_inflated_columns,
+			$updated_course_setting->global_setting->get_inflated_columns }
+		: { $updated_course_setting->get_inflated_columns };
 
-	return $args{as_result_set} ? $updated_course_setting : { $updated_course_setting->get_inflated_columns };
+	# value and default_value are decoded from JSON as a hash.  Return to a value.
+	for my $key (qw/default_value value/) {
+		$setting_to_return->{$key} = $setting_to_return->{$key}->{value} if defined($setting_to_return->{$key});
+	}
+	return $setting_to_return;
 }
 
 =pod
@@ -516,7 +522,17 @@ sub deleteCourseSetting ($self, %args) {
 	my $deleted_setting = $setting->delete;
 
 	return $deleted_setting if $args{as_result_set};
-	return { $deleted_setting->get_inflated_columns };
+
+	my $setting_to_return =
+		($args{merged})
+		? { $deleted_setting->get_inflated_columns, $deleted_setting->global_setting->get_inflated_columns }
+		: { $deleted_setting->get_inflated_columns };
+
+	# value and default_value are decoded from JSON as a hash.  Return to a value.
+	for my $key (qw/default_value value/) {
+		$setting_to_return->{$key} = $setting_to_return->{$key}->{value} if defined($setting_to_return->{$key});
+	}
+	return $setting_to_return;
 }
 
 1;

lib/WeBWorK3.pm

@@ -217,8 +217,7 @@ sub problemRoutes ($app, $course_routes) {
 }
 
 sub settingsRoutes ($self) {
-	$self->routes->get('/webwork3/api/global-settings')->requires(authenticated => 1)
-		->to('Settings#getGlobalSettings');
+	$self->routes->get('/webwork3/api/global-settings')->requires(authenticated => 1)->to('Settings#getGlobalSettings');
 	$self->routes->get('/webwork3/api/global-setting/:setting_id')->requires(authenticated => 1)
 		->to('Settings#getGlobalSetting');
 	$self->routes->get('/webwork3/api/courses/:course_id/settings')->requires(authenticated => 1)

lib/WeBWorK3/Controller/Settings.pm

@@ -18,9 +18,11 @@ sub getGlobalSettings ($c) {
 }
 
 sub getGlobalSetting ($c) {
-	my $setting = $c->schema->resultset('Course')->getGlobalSetting(info => {
-		setting_id => int($c->param('setting_id'))
-	});
+	my $setting = $c->schema->resultset('Course')->getGlobalSetting(
+		info => {
+			setting_id => int($c->param('setting_id'))
+		}
+	);
 	$c->render(json => $setting);
 	return;
 }
@@ -38,8 +40,8 @@ sub getCourseSettings ($c) {
 
 sub updateCourseSetting ($c) {
 	my $course_setting = $c->schema->resultset('Course')->updateCourseSetting(
-		info     => {
-			course_id => $c->param('course_id'),
+		info => {
+			course_id  => $c->param('course_id'),
 			setting_id => $c->param('setting_id')
 		},
 		params => $c->req->json
@@ -50,13 +52,13 @@ sub updateCourseSetting ($c) {
 
 sub deleteCourseSetting ($c) {
 	my $course_setting = $c->schema->resultset('Course')->deleteCourseSetting(
-		info     => {
-			course_id => $c->param('course_id'),
+		info => {
+			course_id  => $c->param('course_id'),
 			setting_id => $c->param('setting_id')
-		});
+		}
+	);
 	$c->render(json => $course_setting);
 	return;
 }
 
-
 1;

lib/WeBWorK3/Utils/Settings.pm

@@ -37,7 +37,7 @@ sub getDefaultCourseSettings () {
 }
 
 my @course_setting_categories = qw/email optional general permissions problem problem_set/;
-my @valid_types = qw/text list multilist boolean int decimal time date_time time_duration timezone/;
+my @valid_types               = qw/text list multilist boolean int decimal time date_time time_duration timezone/;
 
 =pod
 
@@ -90,8 +90,8 @@ sub isValidSetting ($setting, $value = undef) {
 	} elsif ($setting->{type} eq 'multilist') {
 		validateMultilist($setting, $val);
 	} elsif ($setting->{type} eq 'time') {
-		DB::Exception::InvalidCourseFieldType->throw(
-			message => qq/The variable $setting->{setting_name} has value $val and must be a time in the form XX:XX/)
+		DB::Exception::InvalidCourseFieldType->throw(message =>
+				qq/The variable $setting->{setting_name} has value $val and must be a time in the form XX:XX/)
 			unless isTimeString($val);
 	} elsif ($setting->{type} eq 'int') {
 		DB::Exception::InvalidCourseFieldType->throw(
@@ -130,7 +130,8 @@ sub validateList ($setting, $value) {
 	DB::Exception::InvalidCourseFieldType->throw(
 		message => "The options field for the type list in $setting->{setting_name} is missing ")
 		unless defined($setting->{options});
-	DB::Exception::InvalidCourseFieldType->throw(message => "The options field for $setting->{setting_name} is not an ARRAYREF")
+	DB::Exception::InvalidCourseFieldType->throw(
+		message => "The options field for $setting->{setting_name} is not an ARRAYREF")
 		unless ref($setting->{options}) eq 'ARRAY';
 
 	# See if the $setting->{options} is an arrayref of strings or hashrefs.
@@ -158,7 +159,8 @@ sub validateMultilist ($setting, $value) {
 	DB::Exception::InvalidCourseFieldType->throw(
 		message => "The options field for the type multilist in $setting->{setting_name} is missing ")
 		unless defined($setting->{options});
-	DB::Exception::InvalidCourseFieldType->throw(message => "The options field for $setting->{setting_name} is not an ARRAYREF")
+	DB::Exception::InvalidCourseFieldType->throw(
+		message => "The options field for $setting->{setting_name} is not an ARRAYREF")
 		unless ref($setting->{options}) eq 'ARRAY';
 
 	my @diff = array_minus(@{ $setting->{options} }, @$value);

src/components/instructor/SingleSetting.vue

@@ -1,56 +1,76 @@
 <template>
 	<tr>
-		<td width="60%">{{ setting?.doc }}
-			<q-icon v-if="setting?.doc2" name="help" class="q-ml-md">
+		<td width="60%">{{ setting.description }}
+			<q-icon v-if="setting.doc" name="help" class="q-ml-md">
 				<q-tooltip class="text-body2">
-					{{ setting.doc2 }}
+					{{ setting.doc }}
 				</q-tooltip>
 			</q-icon>
 		</td>
 		<td width="40%">
 			<input-with-blur
 				outlined dense
 				v-if="setting?.type === 'text' || setting?.type === 'timezone'"
-				v-model="val"
+				v-model="course_setting.value"
 			/>
-			<q-select v-if="setting?.type === 'list'" v-model="option" :options="options" />
-			<q-input v-if="setting?.type === 'time_duration'" v-model="val" :rules="check_time_dur" />
-			<q-toggle v-if="setting?.type === 'boolean'" v-model="val" />
-			<q-input v-if="setting?.type === 'integer'" v-model="val" :rules="check_int" />
+			<q-select v-if="setting.type === 'list'" v-model="option" :options="options" />
+			<input-with-blur
+				v-if="setting.type === 'time_duration'"
+				v-model="course_setting.value"
+				:rules="[checkTimeDuration]"
+			/>
+			<q-toggle v-if="setting.type === 'boolean'" v-model="course_setting.value" />
+			<q-input v-if="setting.type === 'integer'" v-model="course_setting.value" :rules="[checkInt]" />
 		</td>
 	</tr>
 </template>
 
 <script setup lang="ts">
-import { defineProps, PropType, ref, watch } from 'vue';
-import { CourseSetting, CourseSettingInfo, OptionType } from 'src/common/models/settings';
+import { defineProps, ref, watch } from 'vue';
+import { useQuasar } from 'quasar';
+import { CourseSetting, OptionType } from 'src/common/models/settings';
+
 import InputWithBlur from 'src/components/common/InputWithBlur.vue';
+import { logger } from 'src/boot/logger';
+
 import { useSettingsStore } from 'src/stores/settings';
+import { isTimeDuration } from 'src/common/models/parsers';
 
-const props = defineProps({
-	setting: Object as PropType<CourseSettingInfo>,
-	value: [String, Number, Boolean, Array]
-});
+const props = defineProps<{
+	setting: CourseSetting
+}>();
 
+const $q = useQuasar();
 const settings = useSettingsStore();
-// The 'as string[]` is a hack since the array prop type cannot specify the
-// the type of array.
-const val = ref<string | number | boolean | string[]>(props.value);
+
+const course_setting = ref(props.setting.clone());
+
 const option = ref<OptionType>({ value: '', label: '' });
 const options = ref<Array<OptionType>>([]);
 
-if (props.setting?.options) {
-	options.value = props.setting.options.map((opt: string | OptionType) =>
+const checkInt = (val: string) => Number.isInteger(val) ? true : 'This must be an integer.';
+const checkTimeDuration = (val: string) => isTimeDuration(val) ? true : 'This must be a time duration.';
+
+if (course_setting.value.options) {
+	options.value = course_setting.value.options.map((opt: string | OptionType) =>
 		typeof opt === 'string' ? { label: opt, value: opt } : opt
 	);
-	const v = options.value.find((opt: OptionType) => opt.value === val.value);
+	const v = options.value.find((opt: OptionType) => opt.value === course_setting.value.value);
 	option.value = v || { value: '', label: '' };
 }
 
-watch(() => val.value, () => {
-	void settings.updateCourseSetting(new CourseSetting({
-		var: props.setting?.var,
-		value: val.value
-	}));
+watch(() => course_setting.value.value, async () => {
+	try {
+		await settings.updateCourseSetting(course_setting.value as CourseSetting);
+		const msg = `The setting '${course_setting.value.setting_name}' was updated successfully`;
+		$q.notify({
+			message: msg,
+			color: 'green'
+		});
+		logger.debug(`[CourseSettings/updateCourseSetting]: ${msg}`);
+	} catch (err) {
+		$q.notify({ message: err as string, color: 'red' });
+		logger.error(`[CourseSettings/updateCourseSetting]: ${err as string}`);
+	}
 });
 </script>

src/layouts/MenuBar.vue

@@ -68,7 +68,6 @@ import { endSession } from 'src/common/api-requests/session';
 import { useI18n } from 'vue-i18n';
 import { setI18nLanguage } from 'boot/i18n';
 import { useSessionStore } from 'src/stores/session';
-import type { CourseSettingInfo } from 'src/common/models/settings';
 import { useSettingsStore } from 'src/stores/settings';
 import { logger } from 'src/boot/logger';
 
@@ -99,9 +98,7 @@ const changeCourse = (course_id: number, course_name: string) => {
 	}
 };
 
-const availableLocales = computed(() =>
-	settings.default_settings.find((setting: CourseSettingInfo) => setting.var === 'language')?.options
-);
+const availableLocales = computed(() => settings.getCourseSetting('language')?.options);
 
 const logout = async () => {
 	await endSession();