Simbrief Flight Plan Installation Automation for X-Plane

#!/bin/bash


####################################
# This script enables you to pull  #
# the latest X-Plane 11/12 flight  #
# plan file from Simbrief based    #
# your Simbrief Pilot ID and place #
# it into the proper directory for #
# loading in X-Plane               #
####################################

usage() { echo "USAGE: $0
	General Options:
	-f	Path to X-Plane \"FMS plans\" directory
	-n      Optional file plan name (Default: SB.fms)
	-p	Simbrief Pilot ID
	-w	Working directory
        -v	List all current variable values	

	SMB Mount Options (all required to be set when using smb):
	-d	Target share name on system running X-Plane (Default: "FMS plans")
	-h	Hostname or IP address of smb target system running X-Plane
	-l      Local mount directory name if using smb (Default: "mountdir")
	-s      Use smb for remotely mounting X-Plane "FMS plans" directory (true or false) (Default: false)" 1>&2; exit 1; }

showvars() { echo "======================VARIABLE READOUT======================
Simbrief Pilot ID:                $SB_PILOT_ID
Working Directory:                $WORKING_DIR
FMS Plans Directory:              $XPLANE_FMS_DIR
Flight Plan Output Name:	  $XPLANE_FP_NAME
Use SMB Mount:                    $USE_SMB
Remote Host:                      $SMB_HOST
Remote Share Name:                $SMB_FMS_SHARE_NAME
Local Mount Directory:            $LOCAL_MOUNT_DIR_NAME
============================================================" 1>&2; exit 1; }

## User Variables - Note: You can hardcode any variables you wish in order not to have to input them as execution options
SB_PILOT_ID= # Your Simbrief Pilot ID found in account settings (https://dispatch.simbrief.com/account). Can also be set with -p option
WORKING_DIR= # Directory to work from (you create this). Can also be set with -w option
XPLANE_FMS_DIR= # Path to your X-Plane "FMS plans" directory (X-Plane 11 directory -> Output -> FMS plans). Can also be set with -f option
XPLANE_FP_NAME= SB.fms # Change this if a different filename in your "FMS plans" directory is desired. Can also be set with -n option
## Below variables apply to mounting X-Plane "FMS plans" directory remotely via smb. The expectation is that X-Plane's "FMS plans" directory is shared with
## that name and is accessible & writable by guest without a password. You can also change the mount parameters below if you want to use a specifc user,
## provide a password, change the mount path, etc. 
USE_SMB=false # Set to "true" if using smb. Can also be set with -s option
SMB_HOST= # Hostname or IP of Windows target. Can also be set with -h option
SMB_FMS_SHARE_NAME="FMS plans" # Windows share name. Can also be set with -s option
LOCAL_MOUNT_DIR_NAME=mountdir # This directory will be created for the smb mount. Can also be set with the -l option

while getopts ":p:w:f:n:l:s:h:d:v" opt
do
        case $opt in
      p) SB_PILOT_ID=$OPTARG;;
	  w) WORKING_DIR=$OPTARG;;
	  f) XPLANE_FMS_DIR=$OPTARG;;
	  n) XPLANE_FP_NAME=$OPTARG;;
	  l) LOCAL_MOUNT_DIR_NAME=$OPTARG;;
	  s) USE_SMB=$OPTARG;;
	  h) SMB_HOST=$OPTARG;;
	  d) SMB_FMS_SHARE_NAME=$OPTARG;;
	  v) showvars;;
	  *) usage;;
	esac
done

## Show variable summary
echo -e "\n======================VARIABLE READOUT======================"
echo -e "Simbrief Pilot ID:                $SB_PILOT_ID"
echo "Working Directory:                $WORKING_DIR"
echo "FMS Plans Directory:              $XPLANE_FMS_DIR"
echo "Flight Plan Output Name:	  $XPLANE_FP_NAME"
echo "Use SMB Mount:                    $USE_SMB"
if [ $USE_SMB == true ]
then
	echo "Remote Host:                      $SMB_HOST"
	echo "Remote Share Name:                $SMB_FMS_SHARE_NAME"
	echo -e "Local Mount Directory:            $LOCAL_MOUNT_DIR_NAME"
fi
echo -e "============================================================\n"

## Fetch latest flight plan XML from Simbrief and form URL to download

SB_FP_XML_URL=https://www.simbrief.com/api/xml.fetcher.php?userid=$SB_PILOT_ID
SB_FP_XPE_FILENAME=$(curl --silent $SB_FP_XML_URL | grep xml_file | awk -F"/" '{print $7}' | tr -d \< | sed s/XML/XPE/ | sed s/.xml/.fms/)
SB_FP_XPE_URL=https://www.simbrief.com/ofp/flightplans/$SB_FP_XPE_FILENAME

## Safety check for working directory
if [ ! -d "$WORKING_DIR" ]
then
	echo $(usage)
        echo -e "\nWorking directory not found. Please verify WORKING_DIR variable is correct.\n"
        exit
fi

## If using smb, check to make sure all necessary variables are populated
if [[ -z "$SMB_HOST" || -z "$LOCAL_MOUNT_DIR_NAME" || -z "$SMB_FMS_SHARE_NAME" ]]
then
	 echo $(usage)
	 echo -e "\n Required smb variables unset. Please set all required smb variables and try again.\n"
	 exit
fi

## If using smb, make mount directory if necessary and mount FMS plans share
if [[ $USE_SMB == true ]]
then
	mkdir -p $WORKING_DIR/$LOCAL_MOUNT_DIR_NAME
	mount.cifs //$SMB_HOST/"$SMB_FMS_SHARE_NAME" $WORKING_DIR/$LOCAL_MOUNT_DIR_NAME -o user=guest,password=''
fi

## Safety check for flight plan directory
if [ ! -d "$XPLANE_FMS_DIR" ]
then
	echo $(usage)
        echo -e "\nFlight plan directory not found. Please verify XPLANE_FMS_DIR variable is correct.\n"
	if [[ $USE_SMB == true ]]
	then
		umount -q $WORKING_DIR/$LOCAL_MOUNT_DIR_NAME
		rmdir "$WORKING_DIR/$LOCAL_MOUNT_DIR_NAME"
	fi
        exit
fi

## Download latest flight plan in X-Plane 11/12 format and place into "FMS plans" directory
echo -e "Retrieving flight plan and placing it into $XPLANE_FMS_DIR\n"
echo "================WGET OUTPUT================"
wget --no-verbose $SB_FP_XPE_URL -O $XPLANE_FMS_DIR/$XPLANE_FP_NAME
echo "==========================================="

## Display overview
echo -e "\n==============FLIGHT OVERVIEW=============="
curl --silent $SB_FP_XML_URL | sed -n "/<general>/,/<\/general>/p" | sed "s/  <//g" | sed 's/^[ \t]*//' | sed 's/>/: /g' | grep -v general | cut -d"<" -f1 | sed 's/./\u&/'
echo -e "============================================"
## Output link to file with Vatsim
echo -e "\nShould you wish to file this flight plan with Vatsim, use the following link:"
curl --silent $SB_FP_XML_URL | grep "<link>https://my.vatsim.net/pilots/flightplan" | sed 's/<[^>]*>/\n/g'

## Cleanup for smb mount
if [[ $USE_SMB == true ]]
then
        umount -q $WORKING_DIR/$LOCAL_MOUNT_DIR_NAME
        rmdir $WORKING_DIR/$LOCAL_MOUNT_DIR_NAME
fi

exit