tools: bash from env

[people/ms/suricata.git] / scripts / setup-decoder.sh

#!/usr/bin/env bash
#
# Script to setup a new decoder.
# Written by Victor Julien <victor@inliniac.net>
#

set -e
#set -x

function Usage {
    echo
    echo "$(basename $0) -- script to provision a decoder. The script"
    echo "makes a copy of the decode-template, sets the name and updates"
    echo " the build system."
    echo
    echo "Call from the 'src' directory, with one argument: the decoder name."
    echo
    echo "E.g. inside 'src': ../scripts/$(basename $0) ipv7"
    echo
}

function Done {
    echo
    echo "Decoder $NR has been set up in $FILE_C and $FILE_H and the"
    echo "build system has been updated."
    echo
    echo "The decoder should now compile cleanly. Try running 'make'."
    echo
    echo "Next steps are to edit the files to implement the actual"
    echo "decoding of $NR."
    echo
}

# Make sure we are running from the correct directory.
set_dir() {
    if [ -e ./suricata.c ]; then
	# Do nothing.
	true
    elif [ -e ./src/suricata.c ]; then
	cd src
    else
	echo "error: this does not appear to be a suricata source directory."
	exit 1
    fi
}

if [ $# -ne "1" ]; then
    Usage
    echo "ERROR: call with one argument"
    exit 1
fi

INPUT=$1
# lowercase
LC=${INPUT,,}
#echo $LC
# UPPERCASE
UC=${LC^^}
#echo $UC
# Normal
NR=${LC^}
#echo $NR

FILE_C="decode-${LC}.c"
FILE_H="decode-${LC}.h"
#echo $FILE_C
#echo $FILE_H

set_dir

if [ ! -e decode-template.c ] || [ ! -e decode-template.h ]; then
    Usage
    echo "ERROR: input files decode-template.c and/or decode-template.h are missing"
    exit 1
fi
if [ -e $FILE_C ] || [ -e $FILE_H ]; then
    Usage
    echo "ERROR: file(s) $FILE_C and/or $FILE_H already exist, won't overwrite"
    exit 1
fi

cp decode-template.c $FILE_C
cp decode-template.h $FILE_H

# search and replaces
sed -i "s/TEMPLATE/${UC}/g" $FILE_C
sed -i "s/TEMPLATE/${UC}/g" $FILE_H
sed -i "s/Template/${NR}/g" $FILE_C
sed -i "s/Template/${NR}/g" $FILE_H
sed -i "s/template/${LC}/g" $FILE_C
sed -i "s/template/${LC}/g" $FILE_H
sed -i "s/decode-template.c decode-template.h \\\/decode-template.c decode-template.h \\\\\n${FILE_C} ${FILE_H} \\\/g" Makefile.am

    ed -s decode.h > /dev/null <<EOF
/^int DecodeTEMPLATE
t-
s/DecodeTEMPLATE/Decode${UC}/g
w
EOF


Done
exit 0