From d1ac839333edbfd5de3975a4f64b2168960c0296 Mon Sep 17 00:00:00 2001
From: Jason Ish <ish@unx.ca>
Date: Sun, 1 Oct 2017 10:41:29 +0100
Subject: [PATCH] template scripts: allow to be called from top or src

Allow the template setup script to be called from the top source
directory or from ./src to unify where they can be executed
from.
---
 scripts/setup-app-layer-detect.sh | 41 ++++++++++++++++++++++++++++
 scripts/setup-app-layer-logger.sh | 44 ++++++++++++++++++++++++++++---
 scripts/setup-app-layer.sh        | 17 ++++++++++++
 scripts/setup-decoder.sh          | 20 ++++++++++----
 scripts/setup-simple-detect.sh    | 20 ++++++++++----
 5 files changed, 128 insertions(+), 14 deletions(-)

diff --git a/scripts/setup-app-layer-detect.sh b/scripts/setup-app-layer-detect.sh
index c420e7086b..abfa4978c5 100755
--- a/scripts/setup-app-layer-detect.sh
+++ b/scripts/setup-app-layer-detect.sh
@@ -4,6 +4,12 @@
 
 set -e
 
+# Fail if "ed" is not available.
+if ! which ed > /dev/null 2>&1; then
+    echo "error: the program \"ed\" is required for this script"
+    exit 1
+fi
+
 function usage() {
     cat <<EOF
 
@@ -21,6 +27,19 @@ Examples:
 EOF
 }
 
+# Make sure we are running from the correct directory.
+set_dir() {
+    if [ -e ./suricata.c ]; then
+	cd ..
+    elif [ -e ./src/suricata.c ]; then
+	# Do nothing.
+	true
+    else
+	echo "error: this does not appear to be a suricata source directory."
+	exit 1
+    fi
+}
+
 fail_if_exists() {
     path="$1"
     if test -e "${path}"; then
@@ -119,6 +138,8 @@ w
 EOF
 }
 
+set_dir
+
 protoname="$1"
 buffername="$2"
 
@@ -127,6 +148,26 @@ if [ "${protoname}" = "" ] || [ "${buffername}" = "" ]; then
     exit 1
 fi
 
+# Make sure the protocol name looks like a proper name (starts with a
+# capital letter).
+case "${protoname}" in
+
+    [[:upper:]]*)
+	# OK.
+	;;
+
+    "")
+	usage
+	exit 1
+	;;
+
+    *)
+	echo "error: protocol name must beging with an upper case letter"
+	exit 1
+	;;
+
+esac
+
 protoname_lower=$(printf ${protoname} | tr '[:upper:]' '[:lower:]')
 protoname_upper=$(printf ${protoname} | tr '[:lower:]' '[:upper:]')
 buffername_lower=$(printf ${buffername} | tr '[:upper:]' '[:lower:]')
diff --git a/scripts/setup-app-layer-logger.sh b/scripts/setup-app-layer-logger.sh
index f05be59a28..fb1070238e 100755
--- a/scripts/setup-app-layer-logger.sh
+++ b/scripts/setup-app-layer-logger.sh
@@ -2,6 +2,12 @@
 
 set -e
 
+# Fail if "ed" is not available.
+if ! which ed > /dev/null 2>&1; then
+    echo "error: the program \"ed\" is required for this script"
+    exit 1
+fi
+
 function usage() {
     cat <<EOF
 
@@ -24,6 +30,19 @@ Examples:
 EOF
 }
 
+# Make sure we are running from the correct directory.
+set_dir() {
+    if [ -e ./suricata.c ]; then
+	cd ..
+    elif [ -e ./src/suricata.c ]; then
+	# Do nothing.
+	true
+    else
+	echo "error: this does not appear to be a suricata source directory."
+	exit 1
+    fi
+}
+
 fail_if_exists() {
     path="$1"
     if test -e "${path}"; then
@@ -115,12 +134,29 @@ w
 EOF
 }
 
+set_dir
+
 protoname="$1"
 
-if [ "${protoname}" = "" ]; then
-    usage
-    exit 1
-fi
+# Make sure the protocol name looks like a proper name (starts with a
+# capital letter).
+case "${protoname}" in
+
+    [[:upper:]]*)
+	# OK.
+	;;
+
+    "")
+	usage
+	exit 1
+	;;
+
+    *)
+	echo "error: protocol name must beging with an upper case letter"
+	exit 1
+	;;
+
+esac
 
 protoname_lower=$(printf ${protoname} | tr '[:upper:]' '[:lower:]')
 protoname_upper=$(printf ${protoname} | tr '[:lower:]' '[:upper:]')
diff --git a/scripts/setup-app-layer.sh b/scripts/setup-app-layer.sh
index 73cd89f5b8..01df12d84c 100755
--- a/scripts/setup-app-layer.sh
+++ b/scripts/setup-app-layer.sh
@@ -29,6 +29,19 @@ Examples:
 EOF
 }
 
+# Make sure we are running from the correct directory.
+set_dir() {
+    if [ -e ./suricata.c ]; then
+	cd ..
+    elif [ -e ./src/suricata.c ]; then
+	# Do nothing.
+	true
+    else
+	echo "error: this does not appear to be a suricata source directory."
+	exit 1
+    fi
+}
+
 fail_if_exists() {
     path="$1"
     if test -e "${path}"; then
@@ -143,6 +156,10 @@ w
 EOF
 }
 
+# Main...
+
+set_dir
+
 protoname="$1"
 
 # Make sure the protocol name looks like a proper name (starts with a
diff --git a/scripts/setup-decoder.sh b/scripts/setup-decoder.sh
index 9e60bdfc40..e041226b6b 100755
--- a/scripts/setup-decoder.sh
+++ b/scripts/setup-decoder.sh
@@ -31,6 +31,19 @@ function Done {
     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"
@@ -53,11 +66,8 @@ FILE_H="decode-${LC}.h"
 #echo $FILE_C
 #echo $FILE_H
 
-if [ ! -e ../configure.ac ] || [ ! -e Makefile.am ]; then
-    Usage
-    echo "ERROR: call from src/ directory"
-    exit 1
-fi
+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"
diff --git a/scripts/setup-simple-detect.sh b/scripts/setup-simple-detect.sh
index 309b47cc29..92e35ba2e5 100755
--- a/scripts/setup-simple-detect.sh
+++ b/scripts/setup-simple-detect.sh
@@ -32,6 +32,19 @@ function Done {
     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"
@@ -54,11 +67,8 @@ FILE_H="detect-${LC}.h"
 #echo $FILE_C
 #echo $FILE_H
 
-if [ ! -e ../configure.ac ] || [ ! -e Makefile.am ]; then
-    Usage
-    echo "ERROR: call from src/ directory"
-    exit 1
-fi
+set_dir
+
 if [ ! -e detect-template.c ] || [ ! -e detect-template.h ]; then
     Usage
     echo "ERROR: input files detect-template.c and/or detect-template.h are missing"
-- 
2.47.2