mcq2h5p-eof.sh

#/bin/bash
#===================================================================================
#
#	 				FILE:	mcq2h5p-eof.sh
#
#				USAGE:	mcq2h5p.sh target-questions-file.txt
#
#		where target-questions-file.txt (it may be some other filename), containing your 
#		MC questions and answers, are written in H5P Question Set template markup (see 
#		https://h5p.org/question-set).
#
# DESCRIPTION:	Used for generating an H5P Questions Set (a set of multiple choice 
#		questions with a single correct answer).  A control file (control-eof.txt) 
#		includes certain parameters for the H5P to be created.  The parameter 
#		N_QUESTIONS, the number of questions in the target-questions-file.txt does not 
#		heve to be included.
#
#      AUTHOR:	J.L.A. Uro (justineuro@gmail.com)
#     VERSION:	1.0.1
#     LICENSE:	Creative Commons Attribution 4.0 International License (CC-BY)
#     CREATED:	2024/06/01 10:24:01
#    REVISION:	2024/06/17 14:46:55
#==================================================================================

#####
# set color tags (not all needed)
####
BLACK='\e[1;30m'
RED='\e[1;31m'
GREEN='\e[1;32m'
YELLOW='\e[1;33m'
BLUE='\e[1;34m'
BOLD='\e[1;39m'
BLINK='\e[5m'
OBLINK='\e[25m'
NORM='\e[0m'

#####
# check if questions-file argument was passed at the command line
# (Based on Advanced Bash-Scripting Guide 2014 by Mendel Cooper)
#####
E_NOARGS=85
if [ -z "$1" ]; then
	echo -e "${BLINK}${BOLD}${RED}Error ...${NORM}"
	echo "Usage: ./`basename $0` target-questions-file.txt"
	echo -e "(The ${BOLD}target-questions-file.txt${NORM} should be included at the command line.)"
	exit $E_NOARGS
fi

#####
# remove the old pretty versions: h5p-pr.json, content-pr.json, if they exist
#####
if [ -f "./h5p-pr.json" ]; then rm ./h5p-pr.json; fi
if [ -f "./content-pr.json" ]; then rm ./content-pr.json; fi
sleep 3s # pause for a while

#####
# set color tags (not all needed) to be used for emphases
####
BLACK='\e[1;30m'
RED='\e[1;31m'
GREEN='\e[1;32m'
YELLOW='\e[1;33m'
BLUE='\e[1;34m'
BOLD='\e[1;39m'
BLINK='\e[5m'
OBLINK='\e[25m'
NORM='\e[0m'

#####
# * read the control parameters in the control-eof.txt file; these are
# TITLE: the title of the H5P, set to "THIS IS THE TITLE" as default
# AUTHOR: the name in the author field, set to "I am The Author" as default
# LICENSE: the license, set to ODC PDDL as default
# INTRODUCTION: some blurb about the H5P
# PASS_PERCENTAGE: set to 50% as default
# DISABLE_BACKWARDS_NAVIGATION: set to false as default
# RANDOM_QUESTIONS: set to true as default
# POOL_SIZE: set to five (5) as default as there are 10 questions total
#							in the sample myMCQuestions.txt
# N_QUESTIONS: there are 10 questions in the myMCQuestions.txt (in general, 
#							 this is the total number of questions in your input file
#							 but this doesn't have to be set)
#
#####
# * print to stdout the value of these parameters
#####
echo -e "The following control parameters were set for the H5P to be made (listed in control-eof.txt):"
while read line
do 
	echo $line
	export "$line"
done < ./control-eof.txt

#####
# create h5p.json based on the values of the control parameters read for
# TITLE, AUTHOR, and LICENSE
#####
cat > h5p-pr.json << EOT
{
  "title": $TITLE,
  "language": "und",
  "mainLibrary": "H5P.QuestionSet",
  "embedTypes": [
    "div"
  ],
  "authors": [
    {
      "name": $AUTHOR,
      "role": "Author"
    }
  ],
  "license": $LICENSE,
  "defaultLanguage": "en",
  "preloadedDependencies": [
    {
      "machineName": "H5P.Image",
      "majorVersion": "1",
      "minorVersion": "1"
    },
    {
      "machineName": "H5P.MultiChoice",
      "majorVersion": "1",
      "minorVersion": "16"
    },
    {
      "machineName": "FontAwesome",
      "majorVersion": "4",
      "minorVersion": "5"
    },
    {
      "machineName": "H5P.JoubelUI",
      "majorVersion": "1",
      "minorVersion": "3"
    },
    {
      "machineName": "H5P.Transition",
      "majorVersion": "1",
      "minorVersion": "0"
    },
    {
      "machineName": "H5P.FontIcons",
      "majorVersion": "1",
      "minorVersion": "0"
    },
    {
      "machineName": "H5P.Question",
      "majorVersion": "1",
      "minorVersion": "5"
    },
    {
      "machineName": "H5P.DragQuestion",
      "majorVersion": "1",
      "minorVersion": "14"
    },
    {
      "machineName": "jQuery.ui",
      "majorVersion": "1",
      "minorVersion": "10"
    },
    {
      "machineName": "H5P.QuestionSet",
      "majorVersion": "1",
      "minorVersion": "20"
    },
    {
      "machineName": "H5P.Video",
      "majorVersion": "1",
      "minorVersion": "6"
    },
    {
      "machineName": "flowplayer",
      "majorVersion": "1",
      "minorVersion": "0"
    },
    {
      "machineName": "H5P.MathDisplay",
      "majorVersion": "1",
      "minorVersion": "0"
    }
  ]
}
EOT

#####
# create the top part of the content-pr.json; use the values of 
# INTRODUCTION, PASS_PERCENTAGE, DISABLE_BACKWARDS_NAVIGATION, 
# RANDOM_QUESTIONS, and POOL_SIZE 
#####
cat >> content-pr.json << EOT
{
  "introPage": {
    "showIntroPage": true,
    "startButtonText": "Start Quiz",
    "title": $TITLE,
    "introduction": "<p>${INTRODUCTION:1:-1}<br>\n&nbsp;</p>\n"
  },
  "progressType": "dots",
  "passPercentage": $PASS_PERCENTAGE,
  "disableBackwardsNavigation": $DISABLE_BACKWARDS_NAVIGATION,
  "randomQuestions": $RANDOM_QUESTIONS,
  "endGame": {
    "showResultPage": true,
    "showSolutionButton": true,
    "showRetryButton": true,
    "noResultMessage": "Finished",
    "message": "Your result:",
    "scoreBarLabel": "You got @finals out of @totals points",
    "overallFeedback": [
      {
        "from": 0,
        "to": 100
      }
    ],
    "solutionButtonText": "Show solution",
    "retryButtonText": "Retry",
    "finishButtonText": "Finish",
    "submitButtonText": "Submit",
    "showAnimations": false,
    "skippable": false,
    "skipButtonText": "Skip video"
  },
  "override": {
    "checkButton": true
  },
  "texts": {
    "prevButton": "Previous question",
    "nextButton": "Next question",
    "finishButton": "Finish",
    "submitButton": "Submit",
    "textualProgress": "Question: @current of @total questions",
    "jumpToQuestion": "Question %d of %total",
    "questionLabel": "Question",
    "readSpeakerProgress": "Question @current of @total",
    "unansweredText": "Unanswered",
    "answeredText": "Answered",
    "currentQuestionText": "Current question",
    "navigationLabel": "Questions"
  },
  "poolSize": $POOL_SIZE,
  "questions": [
EOT

n_lines=`wc $1 | awk '{ print $1 }'`
n_lines_nb=`grep -v '^$' $1 | wc | awk '{ print $1 }'`
n_blank_lines=`expr $n_lines - $n_lines_nb`
echo -e "\nThe number of questions to be read from $1: ${BOLD}$n_blank_lines.${NORM}"
if [ "`grep 'N_QUESTIONS' control-eof.txt`" == "" ]; then 
	echo -e "${BOLD}N_QUESTIONS${NORM} is not given in ${BOLD}control-eof.txt${NORM}\n"
elif [ "$N_QUESTIONS" != "$n_blank_lines" ]; then
	echo -e "${BLINK}${YELLOW}Warning:${NORM} ${BOLD}N_QUESTIONS=$N_QUESTIONS${NORM} does not match the total questions of ${BOLD}$n_blank_lines${NORM} in ${BOLD}$1${NORM}\n"
fi

n_blanks=0 # counter for blank lines read
q=0 # indicator if the question part in an item has been processed

declare -a arrline

echo -e "\nReading `expr ${n_blanks} + 1`st question ..."
while read line; do
	# if this is a question line, write question in content-pr.json
	if [ "$q" == "0" ]; then 
		arrline=(`echo -e $line`)
		line=`unset arrline[0]; echo ${arrline[*]}`
		cat >> content-pr.json << EOT
	{
		"library": "H5P.MultiChoice 1.16",
		"params": {
			"question": "$line",
			"answers": [
EOT
		q=`expr $q + 1` # indicator q set to 1 to indicate question part processed
		continue # proceed to next line to process the choices
	elif [ "$line" == "" ]; then  # blank line/end of question
		n_blanks=`expr $n_blanks + 1` # increment . of blank lines
		echo "The number of questions read is now: $n_blanks."
		cat >> content-pr.json << EOT
					}
				],
				"behaviour": {
					"enableRetry": true,
					"enableSolutionsButton": true,
					"enableCheckButton": true,
					"type": "auto",
					"singlePoint": false,
					"randomAnswers": true,
					"showSolutionsRequiresInput": true,
					"confirmCheckDialog": false,
					"confirmRetryDialog": false,
					"autoCheck": false,
					"passPercentage": 100,
					"showScorePoints": true
				},
				"media": {
					"disableImageZooming": false
				},
				"overallFeedback": [
					{
						"from": 0,
						"to": 100
					}
				],
				"UI": {
					"checkAnswerButton": "Check",
					"showSolutionButton": "Show solution",
					"tryAgainButton": "Retry",
					"tipsLabel": "Show tip",
					"scoreBarLabel": "You got :num out of :total points",
					"tipAvailable": "Tip available",
					"feedbackAvailable": "Feedback available",
					"readFeedback": "Read feedback",
					"wrongAnswer": "Wrong answer",
					"correctAnswer": "Correct answer",
					"shouldCheck": "Should have been checked",
					"shouldNotCheck": "Should not have been checked",
					"noInput": "Please answer before viewing the solution",
					"a11yCheck": "Check the answers. The responses will be marked as correct, incorrect, or unanswered.",
					"a11yShowSolution": "Show the solution. The task will be marked with its correct solution.",
					"a11yRetry": "Retry the task. Reset all responses and start the task over again."
				},
				"confirmCheck": {
					"header": "Finish ?",
					"body": "Are you sure you wish to finish ?",
					"cancelLabel": "Cancel",
					"confirmLabel": "Finish"
				},
				"confirmRetry": {
					"header": "Retry ?",
					"body": "Are you sure you wish to retry ?",
					"cancelLabel": "Cancel",
					"confirmLabel": "Confirm"
				}
			},
			"subContentId": "`uuidgen`",
			"metadata": {
				"contentType": "Multiple Choice",
				"license": "U",
				"title": "Untitled Multiple Choice"
			}
EOT
		# the previous last choice is for a question that is NOT the last question
		if [ "$n_blanks" -lt "$n_blank_lines" ]; then
			cat >> content-pr.json << EOT
		}, 
EOT
			q=0 # set q to zero for next question line to be written
			continue # proceed to the stem of the next question
		else # the previous choice is the last for the last question in the file
			cat >> content-pr.json << EOT
		}
EOT
			break # proceed to adding the two closing brackets below 
		fi
	# if line read is a correct answer choice ...
	elif [ "${line:0:1}" == "*" ]; then 
		# if this is the first of the given choices 
		if [ "$q" == "1" ]; then
			cat >> content-pr.json << EOT
					{
						"text": "${line#'*'}",
						"correct": true,
						"tipsAndFeedback": {}
EOT
			q=`expr $q + 1`
		else # if (q>1) this is NOT the first of the given choices
			cat >> content-pr.json << EOT
					},
					{
						"text": "${line#'*'}",
						"correct": true,
						"tipsAndFeedback": {}
EOT
		fi
	else # this must be a wrong answer line
		# if this is the first of the given choices 
		if [ "$q" == "1" ]; then 
			cat >> content-pr.json << EOT
					{
						"text": "${line}",
						"correct": false,
						"tipsAndFeedback": {}
EOT
			q=`expr $q + 1`
		else # if (q>1) this is NOT the first of the given choices
			cat >> content-pr.json << EOT
					},
					{
						"text": "${line}",
						"correct": false,
						"tipsAndFeedback": {}
EOT
		fi
	fi
done < $1
cat >> content-pr.json << EOT
	]
}
EOT

#####
# delete old h5p.json, content.json, if they exist in this directory 
# then replace with the minified JSON files
#####
# delete old JSON
if [ -f "./h5p.json" ]; then rm ./h5p.json; fi
if [ -f "./content.json" ]; then rm ./content.json; fi
echo -e "\nMinifying the JSON files ...\n"
sleep 12s # pause for a while

# minify the new pretty JSON files
script -q -c "jq -c -M < ./h5p-pr.json"; sed -n '2p' typescript | sed 's/.$//' > h5p.json
script -q -c "jq -c -M < ./content-pr.json"; sed -n '2p' typescript | sed 's/.$//' > content.json
rm typescript

# move the JSON files to the appropriate directories of the H5P
mv ./h5p-pr.json ./myNewH5P-mcq-eof
mv ./h5p.json ./myNewH5P-mcq-eof
mv ./content-pr.json ./myNewH5P-mcq-eof/content
mv ./content.json ./myNewH5P-mcq-eof/content

#####
# delete old copy of the H5P, if it exists, then
# generate the new H5P in the current directory
#####
if [ -e "./myNewH5P-mcq-eof.h5p" ]; then rm ./myNewH5P-mcq-eof.h5p; fi
cd myNewH5P-mcq
zip -r -D -X ../myNewH5P-mcq-eof.h5p * >/dev/null
cd $OLDPWD
sleep 2s

#####
# notify locations of newly created files
#####
echo -e "\nThe number of questions read from $1: ${BOLD}$n_blank_lines.${NORM}"
echo -e "\nThe ${BOLD}h5p.json${NORM} file that was created is in this directory: ${BOLD}${YELLOW}./myNewH5P-mcq-eof/${NORM}"
echo -e "The ${BOLD}content.json${NORM} that was created is in this directory: ${BOLD}${YELLOW}./myNewH5P-mcq-eof/content/${NORM}"
echo -e "The ${BLINK}${BOLD}newly created multiple-choice H5P${NORM} is in this directory: ${BOLD}${YELLOW}./myNewH5P-mcq-eof.h5p${NORM}\n"
###
##
#