Clean up the conf file handling.

Rename ww3-dev.dist.yml to webwork3-test.dist.yml.  The ww3 abreviation
is not needed and is inconsistent in naming with the other conf files.

You can now create a separate webwork3-dev.yml file for use in
development.  There is no associated dist file for this.  Just make
whatever changes you want to either of the webwork3*.dist.yml files.

Delete the we_b_wor_k3.yml link.  Just load the appropriate conf file in
conf directly.

Completely eliminate the WW3_ROOT environment variable.  There is no
need for that.  Instead make use of Mojo::Home.  It is made for this.
If you are in an area of the code that has access to the app, then just
use the home helper (in a controller this can be accessed via
$c->app->home).  Elsewhere in the code use Mojo::Home as is done in
lib/WeBWorK3/Utils/Settings.pm.

Also fix the usage of the exception classes in
lib/WeBWorK3/Utils/Settings.pm.  My editor complains about the way those
were imported there.  Furthermore it was entirely inconsistent with the
way the exception classes are imported elsewhere.  There is a mess of
ways that imports are done in the perl files.  This needs further clean
up.  In some places qw// is used, in others qw() is used (both of those
occur in lib/WeBWorK3/Utils/Settings.pm), in yet others a list of
individually quoted imports is used (see lib/DB/WithParams.pm).

@pstaapb: Find some consistency in your coding style.

Author: drgrice1

.gitignore

@@ -9,6 +9,7 @@ node_modules
 
 # Log files
 logs/*
+!logs/.gitkeep
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
@@ -26,8 +27,7 @@ pnpm-debug.log*
 
 # Project files
 sample_db.sqlite
-conf/webwork3.yml
-conf/ww3-dev.yml
+conf/webwork3*.yml
 conf/apache2/webwork3-apache2.conf
 conf/apache2/webwork3.service
 conf/apache2/renderer.service

bin/import_ww2_db.pl

@@ -81,8 +81,7 @@ BEGIN
 # Load the webwork3 configuration file.
 
 my $config_file = "$main::ww3_dir/conf/webwork3.yml";
-die "The file $config_file does not exist.  Did you make a copy of it from ww3-dev.dist.yml ?"
-	unless (-e $config_file);
+$config_file = "$main::ww3_dir/conf/webwork3.yml.dist" unless -e $config_file;
 
 my $config = LoadFile($config_file);
 

conf/ww3-dev.dist.yml conf/webwork3-test.dist.ymlconf/ww3-dev.dist.yml renamed to conf/webwork3-test.dist.yml

@@ -4,38 +4,36 @@ use Mojo::Base 'Mojolicious', -signatures;
 use Mojo::File qw(curfile path);
 use YAML::XS qw/LoadFile/;
 
-BEGIN {
-	use Env qw(WW3_ROOT);
-	$WW3_ROOT = curfile->dirname->dirname->to_string;
-}
-
 use DB::Schema;
 use WeBWorK3::Hooks;
 
 my $perm_table;
 
 # This method will run once at server start
 sub startup ($self) {
-	# log to file if we're in production mode
+	# Pick the config file to use and set up logging dependant on the mode being run in.
+	my $config_file;
 	if ($ENV{MOJO_MODE} && $ENV{MOJO_MODE} eq 'production') {
-		my $path = path("$ENV{WW3_ROOT}/logs")->make_path->child('webwork3.log');
-		$self->log->path($path);
-	}
+		$self->log->path($self->home->child('logs', 'webwork3.log'));
 
-	my $config;
-
-	if ($ENV{MOJO_MODE} && $ENV{MOJO_MODE} eq 'test') {
-		my $path = path("$ENV{WW3_ROOT}/logs")->make_path->child('webwork3_test.log');
-		$self->log->path($path);
+		$config_file = $self->home->child('conf', 'webwork3.yml');
+		$config_file = $self->home->child('conf', 'webwork3.dist.yml') unless -e $config_file;
+	} elsif ($ENV{MOJO_MODE} && $ENV{MOJO_MODE} eq 'test') {
+		$self->log->path($self->home->child('logs', 'webwork3_test.log'));
 		$self->log->level('trace');
-		my $test_config_file = "$ENV{WW3_ROOT}/conf/ww3-dev.yml";
-		$test_config_file = "$ENV{WW3_ROOT}/conf/ww3-dev.dist.yml" unless (-e $test_config_file);
-		$config           = $self->plugin(NotYAMLConfig => { file => $test_config_file });
+
+		$config_file = $self->home->child('conf', 'webwork3-test.yml');
+		$config_file = $self->home->child('conf', 'webwork3-test.dist.yml') unless -e $config_file;
+		$self->plugin(NotYAMLConfig => { file => $config_file });
 	} else {
-		# Load configuration from config file
-		$config = $self->plugin('NotYAMLConfig');
+		$config_file = $self->home->child('conf', 'webwork3-dev.yml');
+		$config_file = $self->home->child('conf', 'webwork3.yml')      unless -e $config_file;
+		$config_file = $self->home->child('conf', 'webwork3.dist.yml') unless -e $config_file;
 	}
 
+	# Load configuration from config file
+	my $config = $self->plugin(NotYAMLConfig => { file => $config_file });
+
 	# Configure the application
 	$self->secrets($config->{secrets});
 
@@ -65,7 +63,7 @@ sub startup ($self) {
 	$self->sessions->secure($config->{cookie_secure});
 
 	# Load permissions and set up a helper for dealing with permissions.
-	$perm_table = LoadFile("$ENV{WW3_ROOT}/conf/permissions.yaml");
+	$perm_table = LoadFile($self->home->child('conf', 'permissions.yaml'));
 	$self->helper(perm_table => sub ($c) { return $perm_table; });
 
 	# Handle all api route exceptions

lib/WeBWorK3.pm

@@ -3,12 +3,11 @@ use warnings;
 use strict;
 
 use Mojo::Base 'Mojolicious::Controller', -signatures;
-use Mojo::File qw(path);
+use Mojo::Home;
 use Mojo::Log;
 use JSON qw(decode_json);
 
-my $path          = path("$ENV{WW3_ROOT}/logs")->make_path->child('clientLog.log');
-my $clientLogFile = Mojo::Log->new(path => $path);
+my $clientLogFile = Mojo::Log->new(path => Mojo::Home->new->detect->child('logs', 'clientLog.log'));
 
 sub clientLog ($c) {
 	my $rawJSON  = $c->req->body;

lib/WeBWorK3/Controller/Logger.pm

@@ -6,6 +6,7 @@ use feature 'signatures';
 no warnings qw(experimental::signatures);
 
 use YAML::XS qw/LoadFile/;
+use Mojo::Home;
 use Carp;
 
 require Exporter;
@@ -15,9 +16,11 @@ our @EXPORT_OK = qw/checkSettings getDefaultCourseSettings getDefaultCourseValue
 	validateSingleCourseSetting validateSettingConfig
 	isInteger isTimeString isTimeDuration isDecimal/;
 
-use DB::Exception::UndefinedCourseField;
-use DB::Exception::InvalidCourseField;
-use DB::Exception::InvalidCourseFieldType;
+use Exception::Class qw(
+	DB::Exception::UndefinedCourseField
+	DB::Exception::InvalidCourseField
+	DB::Exception::InvalidCourseFieldType
+);
 
 use WeBWorK3;
 
@@ -31,7 +34,7 @@ load the default settings from the conf/course_settings.yaml file
 =cut
 
 sub getDefaultCourseSettings () {
-	return LoadFile("$ENV{WW3_ROOT}/conf/course_defaults.yml");
+	return LoadFile(Mojo::Home->new->detect->child('conf', 'course_defaults.yml'));
 }
 
 my @course_setting_categories = qw/email optional general permissions problem problem_set/;

lib/WeBWorK3/Utils/Settings.pm

@@ -28,8 +28,8 @@ use DB::Schema;
 use TestUtils qw/loadCSV removeIDs loadSchema/;
 
 # Load the database
-my $config_file = "$main::ww3_dir/conf/ww3-dev.yml";
-$config_file = "$main::ww3_dir/conf/ww3-dev.dist.yml" unless (-e $config_file);
+my $config_file = "$main::ww3_dir/conf/webwork3-test.yml";
+$config_file = "$main::ww3_dir/conf/webwork3-test.dist.yml" unless (-e $config_file);
 my $config = LoadFile($config_file);
 my $schema = DB::Schema->connect($config->{database_dsn}, $config->{database_user}, $config->{database_password});
 my $strp   = DateTime::Format::Strptime->new(pattern => '%F', on_error => 'croak');

logs/.gitkeep

@@ -27,8 +27,8 @@ use WeBWorK3::Utils::Settings qw/getDefaultCourseSettings getDefaultCourseValues
 use TestUtils qw/removeIDs loadSchema/;
 
 # Load the database
-my $config_file = "$main::ww3_dir/conf/ww3-dev.yml";
-$config_file = "$main::ww3_dir/conf/ww3-dev.dist.yml" unless (-e $config_file);
+my $config_file = "$main::ww3_dir/conf/webwork3-test.yml";
+$config_file = "$main::ww3_dir/conf/webwork3-test.dist.yml" unless (-e $config_file);
 my $config = LoadFile($config_file);
 my $schema = DB::Schema->connect($config->{database_dsn}, $config->{database_user}, $config->{database_password});
 

t/db/001_courses.t

@@ -26,8 +26,8 @@ use DB::Schema;
 use TestUtils qw/loadCSV removeIDs/;
 
 # Load the database
-my $config_file = "$main::ww3_dir/conf/ww3-dev.yml";
-$config_file = "$main::ww3_dir/conf/ww3-dev.dist.yml" unless (-e $config_file);
+my $config_file = "$main::ww3_dir/conf/webwork3-test.yml";
+$config_file = "$main::ww3_dir/conf/webwork3-test.dist.yml" unless (-e $config_file);
 my $config = LoadFile($config_file);
 my $schema = DB::Schema->connect($config->{database_dsn}, $config->{database_user}, $config->{database_password});
 my $strp   = DateTime::Format::Strptime->new(pattern => '%F', on_error => 'croak');