From ef89cfd7497d46f7fde3ed084edeb2fb231e60f0 Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Mon, 17 Apr 2023 10:41:23 +0200
Subject: [PATCH] composite: custom image support

---
 Makefile            |  2 +-
 README.md           |  5 +++
 composite/custom.sh | 75 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 81 insertions(+), 1 deletion(-)
 create mode 100644 composite/custom.sh

diff --git a/Makefile b/Makefile
index 81598c4..9d950a5 100644
--- a/Makefile
+++ b/Makefile
@@ -28,7 +28,7 @@ STEPS=		audit arm base boot chroot clean clone compress confirm \
 		kernel list make.conf nano options packages plugins ports \
 		prefetch print rebase release rename rewind serial sign \
 		skim test update upload verify vga vm xtools
-SCRIPTS=	distribution factory hotfix nightly watch
+SCRIPTS=	custom distribution factory hotfix nightly watch
 
 .PHONY:		${STEPS} ${SCRIPTS}
 
diff --git a/README.md b/README.md
index 47f6e2f..0c2de57 100644
--- a/README.md
+++ b/README.md
@@ -489,6 +489,11 @@ to operate yes or no questions before an action:
 
     # make info confirm dvd
 
+To add arbitrary plugins from an external location into an image you can
+use the following:
+
+    # make custom-<image> ADDITIONS="an-existing-plugin path/to/extra/plugin"
+
 Last but not least, a rebuild of OPNsense core and plugins on package
 sets is invoked using:
 
diff --git a/composite/custom.sh b/composite/custom.sh
new file mode 100644
index 0000000..77c0d14
--- /dev/null
+++ b/composite/custom.sh
@@ -0,0 +1,75 @@
+#!/bin/sh
+
+# Copyright (c) 2023 Franco Fichtner <franco@opnsense.org>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+
+IMAGE=${1}
+
+set -e
+
+eval "$(make print-PLUGINSDIR,PLUGINSENV)"
+
+# handle path-based plugins as custom install for target image
+MISSING=
+PLUGINS=
+PRESENT=
+
+if [ -n "${ADDITIONS}" ]; then
+	for ADDITION in ${ADDITIONS}; do
+		if [ -z "${ADDITION##*/*}" ]; then
+			MISSING="${MISSING} ${ADDITION}"
+		else
+			PRESENT="${PRESENT} ${ADDITION}"
+		fi
+	done
+fi
+
+if [ -z "${IMAGE}" ]; then
+	echo ">>> Cannot continue without image target"
+	exit 1
+fi
+
+ADDITIONS=${PRESENT}
+
+# assume master branch use but provide stable package (PLUGIN_DEVEL empty)
+export PLUGINSBRANCH=master
+export EXTRABRANCH=
+make update-plugins
+
+for PLUGIN in ${MISSING}; do
+	if [ ! -d ${PLUGINSDIR}/${PLUGIN} ]; then
+		echo ">>> Cannot continue without missing plugin ${PLUGIN}"
+		exit 1
+	fi
+
+	# remove previous iterations of the same plugin to be fail-safe
+	NAME=$(make -C ${PLUGINSDIR}/${PLUGIN} PLUGIN_DEVEL= -v PLUGIN_PKGNAME)
+	make plugins-${NAME} PLUGINSLIST="${PLUGIN}" PLUGINSENV="${PLUGINSENV} PLUGIN_DEVEL="
+
+	ADDITIONS="${ADDITIONS} ${NAME}"
+	PLUGINS="${PLUGINS} ${PLUGIN}"
+done
+
+make clean-${IMAGE} ${IMAGE} ADDITIONS="${ADDITIONS}"