mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-26 11:46:54 +00:00
329 lines
9.5 KiB
Bash
Executable File
329 lines
9.5 KiB
Bash
Executable File
#!/bin/bash
|
|
#
|
|
# pnd_make.sh
|
|
#
|
|
# This script is meant to ease generation of a pnd file. Please consult the output
|
|
# when running --help for a list of available parameters and an explaination of
|
|
# those.
|
|
#
|
|
# Required tools when running the script:
|
|
# bash
|
|
# echo, cat, mv, rm
|
|
# mkisofs or mksquashfs (the latter when using the -c param!)
|
|
# xmllint (optional, only for validation of the PXML against the schema)
|
|
|
|
|
|
PXML_schema=$(dirname ${0})/PXML_schema.xsd
|
|
GENPXML_PATH=$(dirname ${0})/genpxml.sh
|
|
|
|
# useful functions ...
|
|
black='\E[30m'
|
|
red='\E[31m'
|
|
green='\E[32m'
|
|
yellow='\E[33m'
|
|
blue='\E[34m'
|
|
magenta='\E[35m'
|
|
cyan='\E[36m'
|
|
white='\E[37m'
|
|
|
|
check_for_tool()
|
|
{
|
|
which $1 &> /dev/null
|
|
if [ "$?" -ne "0" ];
|
|
then
|
|
cecho "ERROR: Could not find the program '$1'. Please make sure
|
|
that it is available in your PATH since it is required to complete your request." $red
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
cecho () # Color-echo. Argument $1 = message, Argument $2 = color
|
|
{
|
|
local default_msg="No message passed." # Doesn't really need to be a local variable.
|
|
message=${1:-$default_msg} # Defaults to default message.
|
|
|
|
# We only output colors when stdout is outputting to a terminal.
|
|
# This avoids color codes being output in log files created on buildbot.
|
|
if [ -t 1 -a -n "$TERM" ]; then
|
|
color=${2:-$black} # Defaults to black, if not specified.
|
|
echo -e "$color$message"
|
|
tput -T"$TERM" sgr0 # Reset to normal.
|
|
else
|
|
echo "$message"
|
|
fi
|
|
return
|
|
}
|
|
|
|
|
|
print_help()
|
|
{
|
|
cat << EOSTREAM
|
|
pnd_make.sh - A script to package "something" into a PND.
|
|
|
|
Usage:
|
|
$(basename ${0}) {--directory|-d} <folder> {--pndname|-p} <file> [{--compress-squashfs|-c}]
|
|
[{--genpxml} <file>] [{--icon|-i} <file>] [{--pxml|-x} <file>]
|
|
[{--schema|-s} <file>] [{--help|-h}]
|
|
|
|
|
|
Switches:
|
|
--compress-squashfs / -c Define whether or not the pnd should be compressed using
|
|
squashfs. If this parameter is selected, a compressed pnd
|
|
will be created.
|
|
|
|
--directory / -d Sets the folder that is to be used for the resulting pnd
|
|
to <folder>. This option is mandatory for the script to
|
|
function correctly.
|
|
|
|
--genpxml Sets the script used for generating a PXML file (if none
|
|
is available already) to <file>. Please make sure to either
|
|
provide a full path or prefix a script in the current folder
|
|
with './' so that the script can actually be executed. If
|
|
this variable is not specified, $GENPXML_PATH
|
|
will be used.
|
|
|
|
--help / -h Displays this help text.
|
|
|
|
--icon / -i Sets the icon that will be appended in the pnd to <file>.
|
|
|
|
--pndname / -p Sets the output filename of the resulting pnd to <file>.
|
|
This option is mandatory for the script to function
|
|
correctly.
|
|
|
|
--pxml / -x Sets the PXML file that is to be used to <file>. If you
|
|
neither provide a PXML file or set this entry to 'guess',
|
|
an existing 'PXML.xml' in your selected '--directory'
|
|
will be used, or the script $GENPXML_PATH
|
|
will be called to try to generate a basic PXML file for you.
|
|
|
|
--schema / -s Sets the schema file, that is to be used for validation,
|
|
to <file. If this is not defined, the script will try to
|
|
use the file '$PXML_schema'. If this fails,
|
|
a warning is issued.
|
|
|
|
If you select the option to create a compressed squashfs, a version >=4.0 of squashfs
|
|
is required to be available in your PATH.
|
|
EOSTREAM
|
|
}
|
|
|
|
|
|
# Parse command line parameters
|
|
while [ "${1}" != "" ]; do
|
|
if [ "${1}" = "--compress-squashfs" ] || [ "${1}" = "-c" ];
|
|
then
|
|
SQUASH=1
|
|
shift 1
|
|
elif [ "${1}" = "--directory" ] || [ "${1}" = "-d" ];
|
|
then
|
|
FOLDER=$2
|
|
shift 2
|
|
elif [ "${1}" = "--genpxml" ];
|
|
then
|
|
GENPXML_PATH=$2
|
|
shift 2
|
|
elif [ "${1}" = "--help" ] || [ "${1}" = "-h" ];
|
|
then
|
|
print_help
|
|
exit 0
|
|
elif [ "${1}" = "--icon" ] || [ "${1}" = "-i" ];
|
|
then
|
|
ICON=$2
|
|
shift 2
|
|
elif [ "${1}" = "--pndname" ] || [ "${1}" = "-p" ];
|
|
then
|
|
PNDNAME=$2
|
|
shift 2
|
|
elif [ "${1}" = "--pxml" ] || [ "${1}" = "-x" ];
|
|
then
|
|
PXML=$2
|
|
shift 2
|
|
elif [ "${1}" = "--schema" ] || [ "${1}" = "-f" ]
|
|
then
|
|
PXML_schema=$2
|
|
shift 2
|
|
else
|
|
cecho "ERROR: '$1' is not a known argument. Printing --help and aborting." $red
|
|
print_help
|
|
exit 1
|
|
fi
|
|
done
|
|
|
|
|
|
# Generate a PXML if the param is set to Guess or it is empty.
|
|
if [ ! $PXML ] || [ $PXML = "guess" ] && [ $PNDNAME ] && [ $FOLDER ];
|
|
then
|
|
if [ -f $FOLDER/PXML.xml ]; # use the already existing PXML.xml file if there is one...
|
|
then
|
|
PXML=$FOLDER/PXML.xml
|
|
PXML_ALREADY_EXISTING="true"
|
|
else
|
|
if [ -f $GENPXML_PATH ];
|
|
then
|
|
$GENPXML_PATH --src $FOLDER --dest $FOLDER --author $USER
|
|
if [ -f $FOLDER/PXML.xml ];
|
|
then
|
|
PXML_GENERATED="true"
|
|
else
|
|
cecho "ERROR: Generating a PXML file using '$GENPXML_PATH' failed.
|
|
Please generate a PXML file manually." $red
|
|
exit 1
|
|
fi
|
|
else
|
|
cecho "ERROR: Could not find '$GENPXML_PATH' for generating a PXML file." $red
|
|
exit 1
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
|
|
# Probe if required variables were set
|
|
echo -e
|
|
cecho "Checking if all required variables were set." $green
|
|
if [ ! $PNDNAME ] || [ ! $FOLDER ] || [ ! $PXML ];
|
|
then
|
|
echo -e
|
|
cecho "ERROR: Not all required options were set! Please see the --help information below." $red
|
|
echo -e
|
|
print_help
|
|
exit 1
|
|
else
|
|
echo "PNDNAME set to '$PNDNAME'."
|
|
fi
|
|
# Check if the selected folder actually exists
|
|
if [ ! -d $FOLDER ];
|
|
then
|
|
echo -e
|
|
cecho "ERROR: '$FOLDER' doesn't exist or is not a folder." $red
|
|
exit 1
|
|
else
|
|
echo "FOLDER set to '$FOLDER'."
|
|
fi
|
|
# Check if the selected PXML file actually exists
|
|
if [ ! -f $PXML ];
|
|
then
|
|
echo -e
|
|
cecho "ERROR: '$PXML' doesn't exist or is not a file." $red
|
|
exit 1
|
|
else
|
|
if [ $PXML_ALREADY_EXISTING ];
|
|
then
|
|
echo "You have not explicitly specified a PXML to use, but an existing file was
|
|
found. Will be using this one."
|
|
elif [ $PXML_GENERATED ];
|
|
then
|
|
echo "A PXML file was generated for you using '$GENPXML_PATH'. This file will
|
|
not be removed at the end of this script because you might want to review it, adjust
|
|
single entries and rerun the script to generate a pnd with a PXML file with all the
|
|
information you want to have listed."
|
|
fi
|
|
echo "PXML set to '$PXML'."
|
|
fi
|
|
|
|
# Print the other variables:
|
|
if [ $ICON ];
|
|
then
|
|
if [ ! -f $ICON ]
|
|
then
|
|
cecho "WARNING: '$ICON' doesn't exist, will not append the selected icon to the pnd." $red
|
|
else
|
|
echo "ICON set to '$ICON'."
|
|
USE_ICON="true"
|
|
fi
|
|
fi
|
|
if [ $SQUASH ];
|
|
then
|
|
echo "Will use a squashfs for '$PNDNAME'."
|
|
fi
|
|
|
|
|
|
# Validate the PXML file (if xmllint is available)
|
|
# Errors and problems in this section will be shown but are not fatal.
|
|
echo -e
|
|
cecho "Trying to validate '$PXML' now. Will be using '$PXML_schema' to do so." $green
|
|
which xmllint &> /dev/null
|
|
if [ "$?" -ne "0" ];
|
|
then
|
|
VALIDATED=false
|
|
cecho "WARNING: Could not find 'xmllint'. Validity check of '$PXML' is not possible!" $red
|
|
else
|
|
if [ ! -f "$PXML_schema" ];
|
|
then
|
|
VALIDATED=false
|
|
cecho "WARNING: Could not find '$PXML_schema'. If you want to validate your
|
|
PXML file please make sure to provide a schema using the --schema option." $red
|
|
else
|
|
xmllint --noout --schema $PXML_schema $PXML
|
|
if [ "$?" -ne "0" ]; then VALIDATED=false; else VALIDATED=true; fi
|
|
fi
|
|
fi
|
|
# Print some message at the end about the validation in case the user missed the output above
|
|
if [ $VALIDATED = "false" ]
|
|
then
|
|
cecho "WARNING: Could not successfully validate '$PXML'. Please check the output
|
|
above. This does not mean that your pnd will be broken. Either you are not following the strict
|
|
syntax required for validation or you don't have all files/programs required for validating." $red
|
|
else
|
|
cecho "Your file '$PXML' was validated successfully. The resulting pnd should
|
|
work nicely with libpnd." $green
|
|
fi
|
|
|
|
|
|
# Make iso from folder
|
|
echo -e
|
|
cecho "Creating an iso file based on '$FOLDER'." $green
|
|
if [ $SQUASH ];
|
|
then
|
|
check_for_tool mksquashfs
|
|
if [ $(mksquashfs -version | awk 'BEGIN{r=0} $3>=4{r=1} END{print r}') -eq 0 ];
|
|
then
|
|
cecho "ERROR: Your squashfs version is older then version 4, please upgrade to 4.0 or later" $red
|
|
exit 1
|
|
fi
|
|
mksquashfs $FOLDER $PNDNAME.iso -nopad -no-recovery
|
|
else
|
|
check_for_tool mkisofs
|
|
mkisofs -o $PNDNAME.iso -R $FOLDER
|
|
fi
|
|
|
|
# Check that the iso file was actually created before continuing
|
|
if [ ! -f $PNDNAME.iso ];
|
|
then
|
|
cecho "ERROR: The temporary file '$PNDNAME.iso' could not be created.
|
|
Please check the output above for any errors and retry after fixing them. Aborting." $red
|
|
exit 1
|
|
fi
|
|
|
|
|
|
# Append pxml to iso
|
|
echo -e
|
|
cecho "Appending '$PXML' to the created iso file." $green
|
|
cat $PNDNAME.iso $PXML > $PNDNAME
|
|
rm $PNDNAME.iso #cleanup
|
|
|
|
|
|
# Append icon if specified and available
|
|
if [ $USE_ICON ];
|
|
then
|
|
echo -e
|
|
cecho "Appending the icon '$ICON' to the pnd." $green
|
|
mv $PNDNAME $PNDNAME.tmp
|
|
cat $PNDNAME.tmp $ICON > $PNDNAME # append icon
|
|
rm $PNDNAME.tmp #cleanup
|
|
fi
|
|
|
|
|
|
# Final message
|
|
echo -e
|
|
if [ -f $PNDNAME ];
|
|
then
|
|
cecho "Successfully finished creating the pnd '$PNDNAME'." $green
|
|
else
|
|
cecho "There seems to have been a problem and '$PNDNAME' was not created. Please check
|
|
the output above for any error messages. A possible cause for this is that there was
|
|
not enough space available." $red
|
|
exit 1
|
|
fi
|
|
|
|
|
|
#if [ $PXML = "guess" ];then rm $FOLDER/PXML.xml; fi #cleanup
|