mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-06 00:45:32 +00:00
5451c70743
Increment needed a guard in order to not abort the script. I have tested locally (stubbing out hdiutil and replacing with false!) -- so I am more confident this time. Test-bot: skip Build-bot: skip Follows: #15176
238 lines
8.1 KiB
Bash
Executable file
238 lines
8.1 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
|
|
## START STANDARD BUILD SCRIPT INCLUDE
|
|
# adjust relative paths as necessary
|
|
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
|
|
. "${THIS_SCRIPT%/*}/../../resources/build/builder-basic.inc.sh"
|
|
## END STANDARD BUILD SCRIPT INCLUDE
|
|
|
|
# Please note that this build script (understandably) assumes that it is running on Mac OS X.
|
|
if ! builder_is_macos; then
|
|
echo "This build script will only run in a Mac environment."
|
|
exit 1
|
|
fi
|
|
|
|
display_usage() {
|
|
echo "Used to create a disk image containing the Keyman Input Method app."
|
|
echo "Typically called from the Keyman mac build script."
|
|
echo
|
|
echo "usage: make-km-dmg.sh"
|
|
echo
|
|
echo "Optional switches:"
|
|
echo " -sourceApp APP The Keyman.app to put into the DMG"
|
|
echo " -template DMG The DMG image to use as a template (with background image, etc.)"
|
|
echo " -destDir DIR Directory where the dmg file should be created (will be"
|
|
echo " created if it does not exist)"
|
|
echo " -quiet Do not print any output except for warnings and errors. If an"
|
|
echo " hdiutil operation fails, no details of the failure will be given."
|
|
echo " -verbose Be verbose: produce extra progress output and error diagnostics."
|
|
echo " This option can help decipher why a particular hdiutil operation"
|
|
echo " failed. At a minimum, the probing of any specified images will"
|
|
echo " be detailed."
|
|
echo " -debug Output a large amount of progress information."
|
|
echo ""
|
|
echo "Note that this script creates/modifies contents of output folder in the directory"
|
|
echo "where this script resides."
|
|
|
|
exit 1
|
|
}
|
|
|
|
KEYMAN_MACIM_BASE_PATH="${BASH_SOURCE[0]}";
|
|
if ([ -h "${KEYMAN_MACIM_BASE_PATH}" ]) then
|
|
while([ -h "${KEYMAN_MACIM_BASE_PATH}" ]) do KEYMAN_MACIM_BASE_PATH=`readlink "${KEYMAN_MACIM_BASE_PATH}"`; done
|
|
fi
|
|
pushd . > /dev/null
|
|
cd `dirname ${KEYMAN_MACIM_BASE_PATH}` > /dev/null
|
|
KEYMAN_MACIM_BASE_PATH=`pwd`;
|
|
popd > /dev/null
|
|
|
|
. "$KEYMAN_ROOT/resources/build/utils.inc.sh"
|
|
|
|
KM_APP_NAME="Install Keyman.app"
|
|
OUTPUT_DIR="$KEYMAN_MACIM_BASE_PATH/output"
|
|
STAGING_DIR="/Volumes/Keyman"
|
|
DEST_DIR="$OUTPUT_DIR/upload"
|
|
SOURCE_KM_APP="$OUTPUT_DIR/$KM_APP_NAME"
|
|
ADD_VERSION_TO_DEST_DIR=true
|
|
TEMPLATE_IMAGE="$KEYMAN_MACIM_BASE_PATH/Keyman-template.dmg"
|
|
VERBOSITY=""
|
|
QUIET=false
|
|
|
|
# Parse args
|
|
while [[ $# -gt 0 ]] ; do
|
|
key="$1"
|
|
case $key in
|
|
-sourceApp)
|
|
if [[ "$2" == "" || "$2" =~ ^\- ]]; then
|
|
builder_die "Missing source directory on command line."
|
|
else
|
|
SOURCE_KM_APP=="$2"
|
|
shift # past argument
|
|
fi
|
|
;;
|
|
-template)
|
|
if [[ "$2" == "" || "$2" =~ ^\- ]]; then
|
|
builder_die "Missing template image on command line."
|
|
elif ! [[ "$2" =~ \.dmg$ ]]; then
|
|
builder_die "Template image must be a .dmg!"
|
|
else
|
|
TEMPLATE_IMAGE="$2"
|
|
shift # past argument
|
|
fi
|
|
;;
|
|
-destDir)
|
|
if [[ "$2" == "" || "$2" =~ ^\- ]]; then
|
|
builder_die "Missing destination directory on command line."
|
|
else
|
|
DEST_DIR="$2"
|
|
ADD_VERSION_TO_DEST_DIR=false
|
|
shift # past argument
|
|
fi
|
|
;;
|
|
-quiet)
|
|
VERBOSITY="-quiet"
|
|
QUIET=true
|
|
;;
|
|
-verbose)
|
|
VERBOSITY="-verbose"
|
|
;;
|
|
-debug)
|
|
VERBOSITY="-debug"
|
|
;;
|
|
-h|-\?|-help|--help)
|
|
display_usage
|
|
;;
|
|
-*)
|
|
builder_die "Unknown option $1. Run with --help for help."
|
|
;;
|
|
esac
|
|
shift # past argument
|
|
done
|
|
|
|
# Step 0 - check parameter and initial file state
|
|
if [ "$KEYMAN_VERSION" = "" ]; then
|
|
builder_die "Required -version parameter not specified!"
|
|
fi
|
|
|
|
if [[ ! -d "$SOURCE_KM_APP" ]]; then
|
|
builder_die "$SOURCE_KM_APP does not exist!"
|
|
fi
|
|
|
|
if [[ ! -f "$TEMPLATE_IMAGE" ]]; then
|
|
builder_die "$TEMPLATE_IMAGE does not exist!"
|
|
fi
|
|
|
|
if [[ ! -e "$OUTPUT_DIR" ]]; then
|
|
mkdir "$OUTPUT_DIR"
|
|
elif [[ ! -d "$OUTPUT_DIR" ]]; then
|
|
builder_die "Output dir exists but is not a directory: $2"
|
|
fi
|
|
|
|
if $ADD_VERSION_TO_DEST_DIR ; then
|
|
DEST_DIR="$DEST_DIR/$KEYMAN_VERSION"
|
|
fi
|
|
if [[ ! -e "$DEST_DIR" ]]; then
|
|
mkdir -p "$DEST_DIR"
|
|
elif [[ ! -d "$DEST_DIR" ]]; then
|
|
builder_die "Destination dir exists but is not a directory: $2"
|
|
fi
|
|
|
|
# TODO: Check that no Keyman volume is already mounted.
|
|
|
|
# Step 1 - Copy template to working copy to prevent unintended changes
|
|
WORKING_COPY_OF_IMAGE="$OUTPUT_DIR/Keyman-temp-$KEYMAN_VERSION.dmg"
|
|
builder_echo info "Copying \"$TEMPLATE_IMAGE\" to \"$WORKING_COPY_OF_IMAGE\"..."
|
|
if [[ -e "$WORKING_COPY_OF_IMAGE" && "$VERBOSITY" != "-quiet" ]] ; then
|
|
builder_warn "Overwriting: $WORKING_COPY_OF_IMAGE"
|
|
fi
|
|
cp -f "$TEMPLATE_IMAGE" "$WORKING_COPY_OF_IMAGE"
|
|
|
|
# Step 2 - Mount (copy of) template image - writeable
|
|
builder_echo info "Attaching \"$WORKING_COPY_OF_IMAGE\"" "Mounting as \"$STAGING_DIR\"..."
|
|
if [[ -e "$STAGING_DIR" ]]; then
|
|
builder_die "Mount folder $STAGING_DIR is already present. Unmount it first."
|
|
fi
|
|
hdiutil attach "$WORKING_COPY_OF_IMAGE" -readwrite -mountpoint "$STAGING_DIR" $VERBOSITY
|
|
if ! [[ $? == 0 && -d "$STAGING_DIR" ]] ; then
|
|
builder_die "Image could not be mounted at: \"$STAGING_DIR\""
|
|
fi
|
|
DEST_KM_APP="$STAGING_DIR/$KM_APP_NAME"
|
|
if ! [[ -d "$DEST_KM_APP" ]] ; then
|
|
hdiutil detach $STAGING_DIR $VERBOSITY
|
|
builder_die "Expected mounted image to contain Keyman app, but \"$DEST_KM_APP\" does not exist."
|
|
fi
|
|
|
|
echo "---- Listing info in /Volumes/Keyman/ ----"
|
|
echo "DEST_KM_APP=$DEST_KM_APP"
|
|
echo "STAGING_DIR=$STAGING_DIR"
|
|
ls -la "$STAGING_DIR"
|
|
ls -la "$STAGING_DIR/background"
|
|
echo "---- End Listing ----"
|
|
|
|
# Step 3 - Replace existing application files with new version
|
|
builder_echo info "Copying files from \"$SOURCE_KM_APP\"..."
|
|
find "$DEST_KM_APP" -mindepth 1 -maxdepth 1
|
|
echo "---------"
|
|
find "$DEST_KM_APP" -mindepth 1 -maxdepth 1 -print0 | xargs -0 rm -rf
|
|
/bin/cp -fR "$SOURCE_KM_APP/" "$DEST_KM_APP"
|
|
|
|
echo "---- Listing info in /Volumes/Keyman/ ----"
|
|
echo "DEST_KM_APP=$DEST_KM_APP"
|
|
echo "STAGING_DIR=$STAGING_DIR"
|
|
ls -la "$STAGING_DIR"
|
|
ls -la "$STAGING_DIR/background"
|
|
echo "---- End Listing ----"
|
|
|
|
# Step 4 - Detach/unmount the temporary image/staging area
|
|
builder_echo info "Detaching \"$WORKING_COPY_OF_IMAGE\""
|
|
|
|
# Attempt to detach 10 times, waiting 5 seconds each time
|
|
# because macOS may still be working in the folder in the
|
|
# background
|
|
DETACH_SUCCESS=0
|
|
DETACH_FORCE=
|
|
while (( DETACH_SUCCESS < 10 )); do
|
|
if hdiutil detach $STAGING_DIR $VERBOSITY $DETACH_FORCE; then
|
|
DETACH_RESULT=0
|
|
echo "hdiutil detach reported success"
|
|
else
|
|
DETACH_RESULT=$?
|
|
echo "hdiutil detach reported failure code ${DETACH_RESULT}"
|
|
fi
|
|
if [[ $DETACH_RESULT != 0 ]] || [[ -d "$STAGING_DIR" ]] ; then
|
|
(( DETACH_SUCCESS++ )) || true
|
|
echo "Failed to unmount: \"$STAGING_DIR\" on attempt #$DETACH_SUCCESS. Waiting 5 seconds to try again."
|
|
if (( DETACH_SUCCESS == 6 )); then
|
|
echo " Note: Detach failed first five times, so now attempting with '-force'"
|
|
DETACH_FORCE=-force
|
|
fi
|
|
sleep 5
|
|
else
|
|
DETACH_SUCCESS=999
|
|
fi
|
|
done
|
|
|
|
if (( DETACH_SUCCESS < 999 )); then
|
|
builder_die "Unable to unmount \"$STAGING_DIR\". Aborting build."
|
|
fi
|
|
|
|
# Step 5 - Convert image to a compressed readonly DMG image
|
|
DMG_FILE_PATH="$DEST_DIR/keyman-$KEYMAN_VERSION_FOR_FILENAME.dmg"
|
|
builder_echo info "Converting/compressing image to create \"$DMG_FILE_PATH\""
|
|
if [[ -e "$DMG_FILE_PATH" ]] ; then
|
|
if [[ "$VERBOSITY" != "-quiet" ]] ; then
|
|
builder_warn "Overwriting: $DMG_FILE_PATH"
|
|
fi
|
|
rm -rf "$DMG_FILE_PATH"
|
|
fi
|
|
hdiutil convert "$WORKING_COPY_OF_IMAGE" -format UDZO -o "$DMG_FILE_PATH" $VERBOSITY
|
|
if ! [[ $? == 0 && -f "$DMG_FILE_PATH" ]]; then
|
|
builder_die "make-km-dmg failed to create \"$DMG_FILE_PATH\"."
|
|
fi
|
|
|
|
# Step 6 - Clean up
|
|
builder_echo info "Cleaning up..."
|
|
rm "$WORKING_COPY_OF_IMAGE"
|
|
|
|
builder_echo info "Make DMG completed successfully."
|
|
exit 0
|