###############################################################################
#                                   LFSMake                                   #
#                    by Rod Roark <rod@sunsetsystems.com>                     #
#                                                                             #
#                        Copyright (C) 2002 Rod Roark                         #
#                                                                             #
# See http://www.lfsmake.org/ for the most current standard version.          #
#                                                                             #
# These Makefiles are made available under the terms of the Artistic License, #
# found at http://www.opensource.org/licenses/artistic-license.html.          #
###############################################################################

###############################################################################
#                                                                             #
# IPFire.org - A linux based firewall                                         #
# Copyright (C) 2007-2023  IPFire Team  <info@ipfire.org>                     #
#                                                                             #
# This program is free software: you can redistribute it and/or modify        #
# it under the terms of the GNU General Public License as published by        #
# the Free Software Foundation, either version 3 of the License, or           #
# (at your option) any later version.                                         #
#                                                                             #
# This program is distributed in the hope that it will be useful,             #
# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
# GNU General Public License for more details.                                #
#                                                                             #
# You should have received a copy of the GNU General Public License           #
# along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
#                                                                             #
###############################################################################

# Cleanup environment from any variables
unexport BUILD_ARCH BUILD_PLATFORM BUILDTARGET CROSSTARGET TOOLCHAIN
unexport NAME SNAME VERSION CORE SLOGAN SYSTEM_RELEASE PAKFIRE_TREE CONFIG_ROOT
unexport KVER KVER_SUFFIX
unexport SYSTEM_PROCESSOR SYSTEM_MEMORY
unexport DEFAULT_PARALLELISM
unexport LFS_BASEDIR
unexport BUILD_DIR
unexport IMAGES_DIR
unexport LOG_DIR
unexport PACKAGES_DIR
unexport TOOLS_DIR
unexport XZ_OPT
unexport ZSTD_OPT

# Basic Variables
EMPTY :=
COMMA := ,
SPACE := $(EMPTY) $(EMPTY)
define NEWLINE


endef

# Basic Functions
join-with	= $(subst $(SPACE),$(1),$(strip $(2)))

PARALLELISM = $(shell echo $$( \
	if [ -n "$(MAX_PARALLELISM)" ] && [ $(MAX_PARALLELISM) -lt 1 ]; then \
		echo 1 ; \
	elif [ -n "$(MAX_PARALLELISM)" ] && [ $(MAX_PARALLELISM) -lt $(DEFAULT_PARALLELISM) ]; then \
		echo $(MAX_PARALLELISM); \
	else \
		echo $(DEFAULT_PARALLELISM); \
	fi) \
)

MAKETUNING = -j$(PARALLELISM)

ifeq "$(TOOLCHAIN)" "1"
	PREFIX = $(TOOLS_DIR)
else
	PREFIX = /usr
endif

TAR_OPTIONS = \
	--format=pax \
	--acls \
	--xattrs \
	--xattrs-include='*' \
	--sparse

# URLs that are common sources of downloads.  If you're having trouble with
# a site you should change its URL to that of a suitable mirror site.
#
URL_IPFIRE  = https://source.ipfire.org/source-2.x

# Don't change this; it will be overridden by other makefiles where necessary.
#
ROOT =

# For most packages tarballs are unpacked here and then deleted after
# installation.
#
DIR_SRC = $(ROOT)/usr/src

# Files are downloaded into DIR_TMP and then moved to DIR_DL, to avoid
# messes with partially retrieved files.  DIR_DL is where we will
# save all the files that are downloaded.  DIR_INFO contains the
# file lists of installed packages.
#
DIR_DL      = $(LFS_BASEDIR)/cache
DIR_CHK     = $(LFS_BASEDIR)/cache/check
DIR_CONF    = $(LFS_BASEDIR)/config
DIR_INFO    = $(LOG_DIR)
DIR_TMP     = /tmp
DIR_TMP_PAK = $(DIR_TMP)/package-$(PROG)

# Add the compiler location and version and specs to the ccache hash
CCACHE_COMPILERCHECK += $(shell gcc -dumpspecs 2>/dev/null | md5sum | cut -d ' ' -f1)

# We support EFI on x86_64 riscv64 and aarch64
ifeq "$(BUILD_ARCH)" "x86_64"
	EFI = 1
	EFI_ARCH = x64
	GRUB_ARCH = $(BUILD_ARCH)
endif

ifeq "$(BUILD_ARCH)" "riscv64"
	EFI = 1
	EFI_ARCH = $(BUILD_ARCH)
	GRUB_ARCH = $(BUILD_ARCH)
endif

ifeq "$(BUILD_ARCH)" "aarch64"
	EFI = 1
	EFI_ARCH = aa64
	GRUB_ARCH = arm64
endif

ifeq "$(BUILD_ARCH)" "loongarch64"
	EFI = 1
	EFI_ARCH = LOONGARCH64
	GRUB_ARCH = $(BUILD_ARCH)
endif

# Go
export GOARCH
export GOOS   = linux
export GOPATH = $(HOME)/gopath

ifeq "$(BUILD_ARCH)" "x86_64"
	GOARCH = amd64
endif

ifeq "$(BUILD_ARCH)" "aarch64"
	GOARCH = arm64
endif

ifeq "$(BUILD_ARCH)" "loongarch64"
	GOARCH = loong64
endif

# Rust
ifeq "$(BUILD_ARCH)" "riscv64"
	RUST_ARCH = riscv64gc
else
	RUST_ARCH = $(BUILD_ARCH)
endif

RUST_PLATFORM = $(RUST_ARCH)-unknown-linux-gnu

CARGO_PATH     = $(DIR_APP)/.cargo
CARGO_REGISTRY = /usr/share/cargo/registry

CRATE_NAME = $(patsubst rust-%,%,$(firstword $(MAKEFILE_LIST)))
CRATE_VER  = $(VER)
CRATE_PATH = $(CARGO_REGISTRY)/$(CRATE_NAME)-$(CRATE_VER)

define CARGO_CONFIG
[build]
rustflags = [$(call join-with,$(COMMA)$(SPACE),$(foreach flag,$(RUSTFLAGS),"$(flag)"))]

[env]
CFLAGS = "$(CFLAGS)"
CXXFLAGS = "$(CXXFLAGS)"
LDFLAGS = "$(LDFLAGS)"

[term]
verbose = true

[source]

[source.local-registry]
directory = "$(CARGO_REGISTRY)"

[source.crates-io]
registry = "https://crates.io"
replace-with = "local-registry"
endef
export CARGO_CONFIG

# Set to false if you want to skip the binary install step
CARGO_HAS_BIN = true

CARGO = \
	CARGOPATH=$(CARGO_PATH) \
	RUSTC_BOOTSTRAP=1 \
	cargo \
	--offline

CARGO_OPTIONS = \
	-Z avoid-dev-deps

# Cargo dealocks on riscv64 when building on multiple cores at the same time
ifeq "$(BUILD_ARCH)" "riscv64"
	CARGO_OPTIONS += -j1
else
	CARGO_OPTIONS += $(MAKETUNING)
endif

define CARGO_PREPARE
	mkdir -p $(CARGO_PATH) && \
	echo "$${CARGO_CONFIG}" > $(CARGO_PATH)/config && \
	rm -f Cargo.lock
endef

CARGO_BUILD = \
	$(CARGO) \
	build \
	--release \
	$(CARGO_OPTIONS)

# Checks whether this crate has a right taregt
CARGO_TARGET_CHECK = $(CARGO) metadata --format-version 1 --no-deps | \
	jq -e ".packages[].targets[].kind | any(. == \"$(1)\")" | grep -q "true"

define CARGO_INSTALL
	mkdir -pv "$(CRATE_PATH)" && \
	if $(call CARGO_TARGET_CHECK,lib) || $(call CARGO_TARGET_CHECK,rlib) || $(call CARGO_TARGET_CHECK,proc-macro); then \
		awk \
			'/^\\\[((.+\\\.)?((dev|build)-)?dependencies|features)/{f=1;next} /^\\\[/{f=0}; !f' \
			< Cargo.toml > Cargo.toml.deps && \
		$(CARGO) package -l | grep -wEv "Cargo.(lock|toml.orig)" \
			| xargs -d "\n" cp -v --parents -a -t $(CRATE_PATH) && \
		install -v -m 644 Cargo.toml.deps $(CRATE_PATH)/Cargo.toml && \
		echo "{\"files\":{},\"package\":\"\"}" > $(CRATE_PATH)/.cargo-checksum.json; \
	fi && \
	if $(CARGO_HAS_BIN) && $(call CARGO_TARGET_CHECK,bin); then \
		$(CARGO) install $(CARGO_OPTIONS) --no-track --path .; \
	fi
endef

###############################################################################
# Common Macro Definitions
###############################################################################

# For each package we create a list of files that it installed under
# log/<TARGET> name. Modified files are not identified
#
define FIND_FILES
	cd $(ROOT)/ && find -mount \
		\( -path '.$(TOOLS_DIR)' -or -path './tmp' -or -path './usr/src' \
		-or -path './run' -or -path './dev' -or -path './proc' \
		-or -path './install' -or -path '.*/__pycache__' \) -prune -or -print | sort
endef

# This is common starting logic for builds.
#
ifeq "$(ROOT)" ""
define PREBUILD
	echo "====================================== Installing $(THISAPP) ..."
	@echo "Install started; saving file list to $(DIR_SRC)/lsalr ..."
	@if [ ! -f $(DIR_SRC)/lsalr ]; then $(FIND_FILES) > $(DIR_SRC)/lsalr; fi
endef
else
define PREBUILD
	echo "====================================== Installing $(THISAPP) ..."
endef
endif

# Common end-of-installation logic for Stage 2 and beyond.
#
ifeq "$(ROOT)" ""
define POSTBUILD
	@echo "Updating linker cache..."
	@type -p ldconfig >/dev/null && ldconfig || :
	@echo "Install done; saving file list to $(TARGET) ..."
	@rm -rf $(GOPATH) /root/.cargo
	@$(FIND_FILES) > $(DIR_SRC)/lsalrnew
	@diff $(DIR_SRC)/lsalr $(DIR_SRC)/lsalrnew | grep '^> ' | sed 's/^> //' > $(TARGET)_diff
	@mv -f $(DIR_SRC)/lsalrnew $(DIR_SRC)/lsalr
	@sed -i -e 's+.\/++' $(TARGET)_diff
	# compare roofile ( same name as lfs script) with the list of installed files
	# special cases
	# - if the corresponding rootfile is not found, touch $(TARGET)_missing_rootfile
	# - on a partial rebuild without a new file inside TARGET_diff, just touch TARGET
	# $(TARGET)_diff : result of the diff
	# ROOTFILE : reference of include/exclude files
	# $(TARGET)_rootfile : ROOTFILE with KVER replacement
	# $(TARGET) : log result with {commented|include|added} files
	@if [ -s "$(TARGET)_diff" ]; then \
		LFS_SCRIPT=$(firstword $(MAKEFILE_LIST))${ROOTFILE_APPEND} ; \
		echo $(LFS_SCRIPT); \
		ROOTFILE=$$(find -L $(DIR_SRC)/config/rootfiles/{common,packages}/{$(BUILD_ARCH),} -maxdepth 1 -type f -name $$LFS_SCRIPT 2>/dev/null | head -1); \
		if [ "$$ROOTFILE" = "" ]; then \
			touch $(TARGET)_missing_rootfile; \
			ROOTFILE=$(TARGET)_missing_rootfile ; \
			echo "error $$LFS_SCRIPT not found in config/rootfiles"; \
		fi; \
		sed -e "s/BUILDTARGET/$(BUILDTARGET)/g" -e "s/KVER/$(KVER)/g" -e "s/xxxMACHINExxx/$(BUILD_ARCH)/g" $$ROOTFILE > $(TARGET)_rootfile; \
		while read -r line; do \
			if grep -qG "^#$$line$$" $(TARGET)_rootfile; then echo "#$$line" >> $(TARGET); \
			elif grep -qG "^$$line$$" $(TARGET)_rootfile ; then echo "$$line" >> $(TARGET); \
			else echo "+$$line" >> $(TARGET); \
			fi; \
		done < $(TARGET)_diff; \
		grep -v "^#" $(TARGET)_rootfile | while read -r line; do \
			if ! grep -qG "^$$line$$" $(TARGET)_diff ; then echo "-$$line" >> $(TARGET); \
			fi; \
		done; \
		rm -f $(TARGET)_rootfile; \
	else \
		touch $(TARGET); \
	fi
	@rm -f $(TARGET)_diff
endef
else
define POSTBUILD
	@echo "===================================== Install done for $(THISAPP)."
	touch $(TARGET)
endef
endif

define CHECK
	@echo -e "$(MESSAGE)Check: $($(notdir $@))"
	wget -T 120 -t 1 --spider -nv -U "IPFireSourceGrabber/2.x" $($(notdir $@)) -O /dev/null
	@touch $(DIR_CHK)/$(notdir $@)
endef

define LOAD
	@echo -e "$(MESSAGE)Download: $($(notdir $@))"
	wget -T 60 -t 1 -nv -U "IPFireSourceGrabber/2.x" $($(notdir $@)) -O $(DIR_TMP)/$(notdir $@)
	[ "$($(notdir $@)_BLAKE2)" = "$$(b2sum $(DIR_TMP)/$(notdir $@) | awk '{ print $$1 }')" ] # detect page not found answer
	mv $(DIR_TMP)/$(notdir $@) $(DIR_DL)
endef

define B2SUM
	# error mean file signature don't match the one in lfs script
	[ "$($@_BLAKE2)" = "$$(b2sum $(DIR_DL)/$@ | awk '{ print $$1 }')" ] && echo "$@ checksum OK"
endef

ARCHIVE_DIR      = /tmp/archive
ARCHIVE_TMP      = $(ARCHIVE_DIR)/.tmp

# The filename of the package file
PACKAGE_FILENAME = $(PROG)-$(VER)-$(PAK_VER).ipfire

# The filename of the meta file
META_FILENAME    = meta-$(PROG)

# Takes one rootfile or a directory and will return a list of all included files
COLLECT_FILES = \
	BUILD_ARCH="$(BUILD_ARCH)" \
	BUILDTARGET="$(BUILDTARGET)" \
	KVER="$(KVER)" \
		$(DIR_SRC)/src/scripts/archive.files $(BUILD_ARCH) $(1) $(2) | tee $(3)

# Takes a filelist from standard input and streams a tarball with all files
__FILES_IN = \
	tar \
		--create \
		$(TAR_OPTIONS) \
		--directory=/ \
		--exclude="dev/pts/*" \
		--exclude="proc/*" \
		--exclude="tmp/*" \
		--exclude="__pycache__" \
		$(if $(1),--exclude-from=$(1)) \
		--files-from=-

# Takes a tarball and extracts it in the target directory
__FILES_OUT = \
	tar \
		--extract \
		$(TAR_OPTIONS) \
		--directory=$(1)

# Copies all files on a rootfile into the given directory
define COPY_FILES
	# Copy all files from $(1) to $(2) ($(3))
	# $4 = rootfile to write out
	# $5 = exclude
	$(call COLLECT_FILES,$(1),$(3),$(4)) | \
		$(call __FILES_IN,$(5)) | \
		$(call __FILES_OUT,$(2))

	# Strip everything, except a few things
	$(DIR_SRC)/src/stripper $(2) \
		--exclude=/lib/firmware \
		--exclude=/usr/lib/go \
		--exclude=/usr/lib/vdr \
		--exclude=/usr/sbin/vdr
endef

# Called to compress a file that will be distributed
__COMPRESS = \
	tar \
		--create \
		--verbose --verbose \
		--use-compress-program="$(3)" \
		$(TAR_OPTIONS) \
		--directory=$(1) \
		--file=$(2) \
		--show-transform \
		--transform="s@^\./@@" \
		.

COMPRESS_XZ   = $(call __COMPRESS,$(1),$(2),xz $(XZ_OPT))
COMPRESS_ZSTD = $(call __COMPRESS,$(1),$(2),zstd $(ZSTD_OPT))

# Command to create a Pakfire package
define CREATE_PACKAGE
	# Compress the package
	tar \
		--create \
		--format=pax \
		--no-acls \
		--no-xattrs \
		--directory=$(1) \
		--file=$(2) \
		--transform="s@^\./@@" \
		.
endef

# Creates the meta file for a Pakfire package
define CREATE_META
	# Clear/create the file
	: > $(2)

	# Write payload
	echo "Name: $(PROG)"							>> $(2)
	echo "Summary: $(SUMMARY)"						>> $(2)
	echo "ProgVersion: $(VER)"						>> $(2)
	echo "Release: $(PAK_VER)"						>> $(2)
	echo "Size: $$(stat --format=%s $(1))"			>> $(2)
	echo "Dependencies: $(DEPS)"					>> $(2)
	echo "File: $(PROG)-$(VER)-$(PAK_VER).ipfire"	>> $(2)
	echo "Services: $(SERVICES)"					>> $(2)
endef

# Helper function to make sure that we have all sorts of mountpoints in the images
CREATE_MOUNTPOINTS = mkdir -pv $(1)/dev $(1)/proc $(1)/sys

define PAK
	# Bringing the files to their right place
	@rm -rf $(ARCHIVE_DIR) && mkdir -p $(ARCHIVE_DIR) $(ARCHIVE_TMP)

	# Install scripts
	cd $(DIR_SRC) && if [ -e "src/paks/$(PROG)" ]; then \
		install -v -m 744 src/paks/$(PROG)/{install,uninstall,update}.sh $(ARCHIVE_DIR); \
	else \
		install -v -m 744 src/paks/default/{install,uninstall,update}.sh $(ARCHIVE_DIR); \
	fi

	# Copy all files
	$(call COPY_FILES,$(DIR_SRC)/config/rootfiles/packages,$(ARCHIVE_TMP),$(PROG),$(ARCHIVE_DIR)/ROOTFILES)

	# Compress tarball
	$(call COMPRESS_XZ,$(ARCHIVE_TMP),$(ARCHIVE_DIR)/files.tar.xz)

	# Cleanup temporary files
	rm -rf $(ARCHIVE_TMP)

	# Create the package
	$(call CREATE_PACKAGE,$(ARCHIVE_DIR),$(PACKAGES_DIR)/$(PACKAGE_FILENAME))

	# Write the meta file
	$(call CREATE_META,$(PACKAGES_DIR)/$(PACKAGE_FILENAME),$(PACKAGES_DIR)/$(META_FILENAME))

	# Cleanup
	rm -rf $(ARCHIVE_DIR)
endef

define INSTALL_INITSCRIPT
	install -m 754 -v $(DIR_SRC)/src/initscripts/packages/$(1)  /etc/rc.d/init.d/$(1)
endef

define INSTALL_INITSCRIPTS
	for initscript in $(1); do \
		$(call INSTALL_INITSCRIPT,$$initscript) || exit 1; \
    done
endef

ifeq "$(BUILD_ARCH)" "$(filter $(BUILD_ARCH),aarch64 riscv64 loongarch64)"
define UPDATE_AUTOMAKE
	for i in $$(find $(DIR_APP) -name config.guess -o -name config.sub); do \
		cp -vf /usr/share/automake*/$$(basename $${i}) $${i} || \
			cp -vf $(TOOLS_DIR)/share/automake*/$$(basename $${i}) $${i}; \
	done
endef
endif