Remove the update-ww script, return the download-OPL script ...

to it's previous state and now run the parse-search-json.pl script upon startup of webwork2.

Restore the minisearch package.

Author: pstaabp

bin/build-search-json.pl

@@ -9,23 +9,18 @@ =head1 SYNOPSIS
 build-search-db.pl [options]
 
  Options:
-   -p|--pg-root          Directory containing  a git clone of pg.
-                         If this option is not set, then the environment
-                         variable $PG_ROOT will be used if it is set.
    -f|--json-file        Location (relative to WW_ROOT) to store the resulting JSON file.
                          Default value is htdocs/DATA/search.json
-   -s|--sample-prob-dir  Location (relative to $PG_ROOT) where the sample problems are located.
+   -s|--sample-prob-dir  Location (relative to $pg_root) where the sample problems are located.
                          Default value is tutorial/samples-problems
    -b|--build            One of (all, macros, samples) to determine if the macros, sample
                          problems or both should be scraped for data.
    -v|--verbose          Setting this flag provides details as the script runs.
-
-Note that --pg-root must be provided or the PG_ROOT environment variable set
-if the POD for pg is desired.
+   -h|--help             Show this help message.
 
 =head1 DESCRIPTION
 
-This script parses all of the files in $PG_ROOT/tutorial/samples-problems and the POD in the macro files.
+This script parses all of the files in $pg_root/tutorial/samples-problems and the POD in the macro files.
 The result is a JSON file containing information about every file to be searched for in the sample-problems
 space.  The purpose of creating this file is to be used on the Sample Problems page (linked from
 the PG Editor) to search through macros and samples problems.
@@ -42,34 +37,37 @@ =head1 DESCRIPTION
 use Mojo::JSON qw(encode_json);
 use Mojo::File qw(curfile);
 use Pod::Simple::SimpleTree;
+use Pod::Usage;
+use YAML::XS qw(LoadFile);
+
+my $ww_root = Mojo::File->curfile->dirname->dirname;
+
+# Load the configuration file to obtain the PG root directory.
+my $config_file = "$ww_root/conf/webwork2.mojolicious.yml";
+$config_file = "$ww_root/conf/webwork2.mojolicious.dist.yml" unless -e $config_file;
+my $config = LoadFile($config_file);
 
+my $pg_root = $config->{pg_dir};
 my $build   = "all";
-my $pg_root = $ENV{PG_ROOT};
 
 # These are the default sample problem directory and JSON file.
 my $sample_prob_dir = "tutorial/sample-problems";
 my $json_file       = "htdocs/DATA/search.json";
-my ($verbose, $show_warnings) = (1, 0);
+my ($verbose, $show_warnings, $show_help) = (0, 0, 0);
 
 GetOptions(
-	'p|pg-root=s'         => \$pg_root,
 	'f|json-file=s'       => \$json_file,
 	's|sample-prob-dir=s' => \$sample_prob_dir,
 	'b|build=s'           => \$build,
 	'w|show-warnings'     => \$show_warnings,
-	'v|verbose+'          => \$verbose
+	'v|verbose+'          => \$verbose,
+	'h|help'              => \$show_help
 );
+pod2usage(2) if $show_help;
 
 die "The build options must be one of (all, macros, samples). The value $build is not valid."
 	if ((grep { $_ eq $build } qw/all macros samples/) != 1);
 
-my $ww_root = $ENV{WW_ROOT};
-$ww_root = Mojo::File->curfile->dirname->dirname->realpath unless defined($ww_root);
-
-say $ww_root;
-
-die "ww_root: $ww_root is not a directory" unless -d $ww_root;
-
 $sample_prob_dir = "$pg_root/$sample_prob_dir";
 $json_file       = Mojo::File->new("$ww_root/$json_file");
 

bin/download-OPL-metadata-release.pl

@@ -80,12 +80,8 @@ BEGIN
 die "The directory $libraryDirectory does not exist or is not writable."
 	if (!-d $libraryDirectory || !-w $libraryDirectory);
 
-warn $ENV{OPL_GIT_REPOSITORY};
-
-my $git_repo = $ENV{OPL_GIT_REPOSITORY} // 'origin';
-
 # Checkout the release tag in the library clone if it hasn't already been done.
-`$ce->{externalPrograms}{git} -C $libraryDirectory fetch --tags $git_repo`;
+`$ce->{externalPrograms}{git} -C $libraryDirectory fetch --tags origin`;
 `$ce->{externalPrograms}{git} -C $libraryDirectory show-ref refs/heads/$releaseTag -q`;
 if ($?) {
 	say "Switching OPL clone in $libraryDirectory to new branch of release tag $releaseTag.";

bin/update-ww.pl

@@ -2,6 +2,7 @@
 
 use strict;
 use warnings;
+use feature 'say';
 
 BEGIN {
 	use Mojo::File qw(curfile);
@@ -26,5 +27,16 @@ use Mojolicious::Commands;
 use lib "$WEBWORK_ROOT/lib";
 use lib "$PG_ROOT/lib";
 
+# Build the search database if it doesn't exist (or is XXX days old)
+
+unless (-f "$WEBWORK_ROOT/htdocs/DATA/search.json") {
+	say "Building the search json file.";
+	`$WEBWORK_ROOT/bin/build-search-json.pl`;
+	say "There was an error running the build-search-json.pl script.  Try running it manually with "
+		. "the verbose flag." if $?;
+	say "Successfully built the search json file at $WEBWORK_ROOT/htdocs/DATA/search.json"
+		if -f "$WEBWORK_ROOT/htdocs/DATA/search.json";
+}
+
 # Start command line interface for application
 Mojolicious::Commands->start_app('Mojolicious::WeBWorK');

bin/webwork2

@@ -5,16 +5,25 @@
 (() => {
 	const miniSearch = new MiniSearch({ fields: ['terms', 'filename', 'name', 'description', 'methods'] });
 	let pages;
+	const resultList = document.getElementById('searchResults');
 	// This is the data from sample-problems/macros POD.
 	fetch('../../DATA/search.json')
 		.then((res) => res.json())
 		.then((p) => {
 			pages = p;
 			miniSearch.addAll(pages);
 		})
-		.catch((e) => console.error(e));
+		.catch((e) => {
+			if (e) {
+				console.error(e);
+				const error_box = document.createElement('div');
+				error_box.classList.add('alert', 'alert-danger');
+				error_box.innerText =
+					'There was a error loading the search box. Please contact the webwork administrator';
+				resultList.append(error_box);
+			}
+		});
 
-	const resultList = document.getElementById('searchResults');
 	const searchBox = document.getElementById('searchDocs');
 	document.getElementById('clearSearchButton').addEventListener('click', () => {
 		searchBox.value = '';

htdocs/js/SampleProblemViewer/search.js

@@ -22,6 +22,7 @@
 		"jquery-ui-dist": "^1.13.2",
 		"luxon": "^3.4.4",
 		"mathjax": "^3.2.2",
+		"minisearch": "^7.1.2",
 		"shortcut-buttons-flatpickr": "^0.4.0",
 		"sortablejs": "^1.15.2"
 	},