core/Makefile
Franco Fichtner 856574bbef dhcp: use a simple periodic update for now; closes #5876
Gets rid of package dependency which for dhcpleases6 simply
listens on the DHCPD lease file and runs the prefix.php command
unconditionally.

For now emulate this by issuing the command every 60 seconds
which can be adjusted later if someone complains, but seeing
how many bugs this script has had vs. how many people noticed
it (basically none) I doult this will have much impact overall.
2022-07-20 11:37:18 +02:00

527 lines
15 KiB
Makefile

# Copyright (c) 2014-2022 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.
all:
@cat ${.CURDIR}/README.md | ${PAGER}
.include "Mk/defaults.mk"
CORE_ABI?= 22.1
CORE_MESSAGE?= Carry on my wayward son
CORE_NAME?= opnsense-devel
CORE_NICKNAME?= Not Yet
CORE_TYPE?= development
.for REPLACEMENT in ABI PHP PYTHON
. if empty(CORE_${REPLACEMENT})
. warning Cannot build without CORE_${REPLACEMENT} set
. endif
CORE_MAKE+= CORE_${REPLACEMENT}=${CORE_${REPLACEMENT}}
.endfor
_CORE_NEXT= ${CORE_ABI:C/\./ /}
.if ${_CORE_NEXT:[2]} == 7 # community
CORE_NEXT!= expr ${_CORE_NEXT:[1]} + 1
CORE_NEXT:= ${CORE_NEXT}.1
.elif ${_CORE_NEXT:[2]} == 10 # business
CORE_NEXT!= expr ${_CORE_NEXT:[1]} + 1
CORE_NEXT:= ${CORE_NEXT}.4
.elif ${_CORE_NEXT:[2]} == 1 # community
CORE_NEXT= ${_CORE_NEXT:[1]}
CORE_NEXT:= ${CORE_NEXT}.7
.elif ${_CORE_NEXT:[2]} == 4 # business
CORE_NEXT= ${_CORE_NEXT:[1]}
CORE_NEXT:= ${CORE_NEXT}.10
.else
.error Unsupported minor version for CORE_ABI=${CORE_ABI}
.endif
.if exists(${GIT}) && exists(${GITVERSION}) && exists(${.CURDIR}/.git)
. if ${CORE_TYPE:M[Dd][Ee][Vv]*}
_NEXTBETA!= ${GIT} tag -l ${CORE_NEXT}.b
. if !empty(_NEXTBETA)
_NEXTMATCH= --match=${CORE_NEXT}.b
. else
_NEXTALPHA!= ${GIT} tag -l ${CORE_NEXT}.a
. if !empty(_NEXTALPHA)
_NEXTMATCH= --match=${CORE_NEXT}.a
. else
_NEXTDEVEL!= ${GIT} tag -l ${CORE_ABI}\*
. if !empty(_NEXTDEVEL)
_NEXTMATCH= --match=${CORE_ABI}\*
. endif
. endif
. endif
. elif ${CORE_TYPE:M[Bb][Uu][Ss]*}
_NEXTMATCH= '' # XXX verbatim match for now
. else
_NEXTSTABLE!= ${GIT} tag -l ${CORE_ABI}\*
. if !empty(_NEXTSTABLE)
_NEXTMATCH= --match=${CORE_ABI}\*
. endif
. endif
. if empty(_NEXTMATCH)
. error Did not find appropriate tag for CORE_ABI=${CORE_ABI}
. endif
CORE_COMMIT!= ${GITVERSION} ${_NEXTMATCH}
.endif
CORE_COMMIT?= unknown 0 undefined
CORE_VERSION?= ${CORE_COMMIT:[1]}
CORE_REVISION?= ${CORE_COMMIT:[2]}
CORE_HASH?= ${CORE_COMMIT:[3]}
CORE_DEVEL?= master
CORE_STABLE?= stable/${CORE_ABI}
_CORE_SERIES= ${CORE_VERSION:S/./ /g}
CORE_SERIES?= ${_CORE_SERIES:[1]}.${_CORE_SERIES:[2]}
.if "${CORE_REVISION}" != "" && "${CORE_REVISION}" != "0"
CORE_PKGVERSION= ${CORE_VERSION}_${CORE_REVISION}
.else
CORE_PKGVERSION= ${CORE_VERSION}
.endif
CORE_PYTHON_DOT= ${CORE_PYTHON:C/./&./1}
.if "${CORE_FLAVOUR}" == OpenSSL
CORE_REPOSITORY?= ${CORE_ABI}/latest
.elif "${CORE_FLAVOUR}" == LibreSSL
CORE_REPOSITORY?= ${CORE_ABI}/libressl
.else
CORE_REPOSITORY?= unsupported/${CORE_FLAVOUR:tl}
.endif
CORE_COMMENT?= ${CORE_PRODUCT} ${CORE_TYPE} release
CORE_MAINTAINER?= project@opnsense.org
CORE_ORIGIN?= opnsense/${CORE_NAME}
CORE_PACKAGESITE?= https://pkg.opnsense.org
CORE_PRODUCT?= OPNsense
CORE_WWW?= https://opnsense.org/
CORE_COPYRIGHT_HOLDER?= Deciso B.V.
CORE_COPYRIGHT_WWW?= https://www.deciso.com/
CORE_COPYRIGHT_YEARS?= 2014-2022
CORE_DEPENDS_amd64?= beep \
suricata-devel
# XXX transition helpers for PHP 8 migration
CORE_DEPENDS_PHP74= php74-json php74-openssl
CORE_DEPENDS?= ca_root_nss \
choparp \
cpustats \
dhcp6c \
dnsmasq \
dpinger \
expiretable \
filterlog \
flock \
flowd \
hostapd \
ifinfo \
iftop \
isc-dhcp44-relay \
isc-dhcp44-server \
lighttpd \
monit \
mpd5 \
ntp \
openssh-portable \
openvpn \
opnsense-installer \
opnsense-lang \
opnsense-update \
pam_opnsense \
pftop \
php${CORE_PHP}-ctype \
php${CORE_PHP}-curl \
php${CORE_PHP}-dom \
php${CORE_PHP}-filter \
php${CORE_PHP}-gettext \
php${CORE_PHP}-google-api-php-client \
php${CORE_PHP}-ldap \
php${CORE_PHP}-pdo \
php${CORE_PHP}-pecl-radius \
php${CORE_PHP}-phalcon \
php${CORE_PHP}-phpseclib \
php${CORE_PHP}-session \
php${CORE_PHP}-simplexml \
php${CORE_PHP}-sockets \
php${CORE_PHP}-sqlite3 \
php${CORE_PHP}-xml \
php${CORE_PHP}-zlib \
${CORE_DEPENDS_PHP${CORE_PHP}} \
pkg \
py${CORE_PYTHON}-Jinja2 \
py${CORE_PYTHON}-dnspython \
py${CORE_PYTHON}-netaddr \
py${CORE_PYTHON}-requests \
py${CORE_PYTHON}-sqlite3 \
py${CORE_PYTHON}-ujson \
py${CORE_PYTHON}-vici \
radvd \
rrdtool \
samplicator \
squid \
strongswan \
sudo \
syslog-ng \
unbound \
wpa_supplicant \
zip \
${CORE_DEPENDS_${CORE_ARCH}}
WRKDIR?=${.CURDIR}/work
WRKSRC?=${WRKDIR}/src
PKGDIR?=${WRKDIR}/pkg
MFCDIR?=${WRKDIR}/mfc
WANTS= p5-File-Slurp php${CORE_PHP}-pear-PHP_CodeSniffer \
phpunit7-php${CORE_PHP} py${CORE_PYTHON}-pycodestyle
.for WANT in ${WANTS}
want-${WANT}:
@${PKG} info ${WANT} > /dev/null
.endfor
mount:
@if [ ! -f ${WRKDIR}/.mount_done ]; then \
echo -n "Enabling core.git live mount..."; \
sed ${SED_REPLACE} ${.CURDIR}/src/opnsense/version/core.in > \
${.CURDIR}/src/opnsense/version/core; \
mount_unionfs ${.CURDIR}/src ${LOCALBASE}; \
touch ${WRKDIR}/.mount_done; \
echo "done"; \
service configd restart; \
fi
umount:
@if [ -f ${WRKDIR}/.mount_done ]; then \
echo -n "Disabling core.git live mount..."; \
umount -f "<above>:${.CURDIR}/src"; \
rm ${WRKDIR}/.mount_done; \
echo "done"; \
service configd restart; \
fi
manifest:
@echo "name: \"${CORE_NAME}\""
@echo "version: \"${CORE_PKGVERSION}\""
@echo "origin: \"${CORE_ORIGIN}\""
@echo "comment: \"${CORE_COMMENT}\""
@echo "desc: \"${CORE_HASH}\""
@echo "maintainer: \"${CORE_MAINTAINER}\""
@echo "www: \"${CORE_WWW}\""
@echo "message: \"${CORE_MESSAGE}\""
@echo "categories: [ \"sysutils\", \"www\" ]"
@echo "licenselogic: \"single\""
@echo "licenses: [ \"BSD2CLAUSE\" ]"
@echo "prefix: ${LOCALBASE}"
@echo "vital: true"
@echo "deps: {"
@for CORE_DEPEND in ${CORE_DEPENDS}; do \
if ! ${PKG} query ' %n: { version: "%v", origin: "%o" }' \
$${CORE_DEPEND}; then \
echo ">>> Missing dependency: $${CORE_DEPEND}" >&2; \
exit 1; \
fi; \
done
@echo "}"
.if ${.TARGETS:Mupgrade}
# lighter package format for quick completion
PKG_FORMAT?= -f tar
.endif
PKG_SCRIPTS= +PRE_INSTALL +POST_INSTALL \
+PRE_UPGRADE +POST_UPGRADE \
+PRE_DEINSTALL +POST_DEINSTALL
scripts:
.for PKG_SCRIPT in ${PKG_SCRIPTS}
@if [ -f ${.CURDIR}/${PKG_SCRIPT} ]; then \
cp -- ${.CURDIR}/${PKG_SCRIPT} ${DESTDIR}/; \
fi
.endfor
install:
@${CORE_MAKE} -C ${.CURDIR}/contrib install DESTDIR=${DESTDIR}
@${CORE_MAKE} -C ${.CURDIR}/src install DESTDIR=${DESTDIR} ${MAKE_REPLACE}
.if exists(${LOCALBASE}/opnsense/www/index.php)
# try to update the current system if it looks like one
@touch ${LOCALBASE}/opnsense/www/index.php
.endif
collect:
@(cd ${.CURDIR}/src; find * -type f) | while read FILE; do \
if [ -f ${DESTDIR}${LOCALBASE}/$${FILE} ]; then \
tar -C ${DESTDIR}${LOCALBASE} -cpf - $${FILE} | \
tar -C ${.CURDIR}/src -xpf -; \
fi; \
done
bootstrap:
@${CORE_MAKE} -C ${.CURDIR}/src install-bootstrap DESTDIR=${DESTDIR} \
NO_SAMPLE=please ${MAKE_REPLACE}
plist:
@(${CORE_MAKE} -C ${.CURDIR}/contrib plist && \
${CORE_MAKE} -C ${.CURDIR}/src plist) | sort
plist-fix:
@${CORE_MAKE} DESTDIR=${DESTDIR} plist > ${.CURDIR}/plist
plist-check:
@mkdir -p ${WRKDIR}
@${CORE_MAKE} DESTDIR=${DESTDIR} plist > ${WRKDIR}/plist.new
@cat ${.CURDIR}/plist > ${WRKDIR}/plist.old
@if ! diff -q ${WRKDIR}/plist.old ${WRKDIR}/plist.new > /dev/null ; then \
diff -u ${WRKDIR}/plist.old ${WRKDIR}/plist.new || true; \
echo ">>> Package file lists do not match. Please run 'make plist-fix'." >&2; \
rm ${WRKDIR}/plist.*; \
exit 1; \
fi
@rm ${WRKDIR}/plist.*
metadata:
@mkdir -p ${DESTDIR}
@${CORE_MAKE} DESTDIR=${DESTDIR} scripts
@${CORE_MAKE} DESTDIR=${DESTDIR} manifest > ${DESTDIR}/+MANIFEST
@${CORE_MAKE} DESTDIR=${DESTDIR} plist > ${DESTDIR}/plist
package-check:
@if [ -f ${WRKDIR}/.mount_done ]; then \
echo ">>> Cannot continue with live mount. Please run 'make umount'." >&2; \
exit 1; \
fi
package: plist-check package-check clean-wrksrc
.for CORE_DEPEND in ${CORE_DEPENDS}
@if ! ${PKG} info ${CORE_DEPEND} > /dev/null; then ${PKG} install -yfA ${CORE_DEPEND}; fi
.endfor
@echo -n ">>> Generating metadata for ${CORE_NAME}-${CORE_PKGVERSION}..."
@${CORE_MAKE} DESTDIR=${WRKSRC} metadata
@echo " done"
@echo -n ">>> Staging files for ${CORE_NAME}-${CORE_PKGVERSION}..."
@${CORE_MAKE} DESTDIR=${WRKSRC} install
@echo " done"
@echo ">>> Generated version info for ${CORE_NAME}-${CORE_PKGVERSION}:"
@cat ${WRKSRC}/usr/local/opnsense/version/core
@echo ">>> Packaging files for ${CORE_NAME}-${CORE_PKGVERSION}:"
@PORTSDIR=${.CURDIR} ${PKG} create ${PKG_FORMAT} -v -m ${WRKSRC} \
-r ${WRKSRC} -p ${WRKSRC}/plist -o ${PKGDIR}
upgrade-check:
@if ! ${PKG} info ${CORE_NAME} > /dev/null; then \
echo ">>> Cannot find package. Please run 'opnsense-update -t ${CORE_NAME}'" >&2; \
exit 1; \
fi
@if [ "$$(${VERSIONBIN} -vH)" = "${CORE_PKGVERSION} ${CORE_HASH}" ]; then \
echo "Installed version already matches ${CORE_PKGVERSION} ${CORE_HASH}" >&2; \
exit 1; \
fi
upgrade: upgrade-check clean-pkgdir package
@${PKG} delete -fy ${CORE_NAME} || true
@${PKG} add ${PKGDIR}/*.pkg
@${.CURDIR}/src/sbin/pluginctl webgui
lint-shell:
@find ${.CURDIR}/src ${.CURDIR}/Scripts \
-name "*.sh" -type f -print0 | xargs -0 -n1 sh -n
lint-xml:
@find ${.CURDIR}/src ${.CURDIR}/Scripts \
-name "*.xml*" -type f -print0 | xargs -0 -n1 xmllint --noout
SCRIPTDIRS!= find ${.CURDIR}/src/opnsense/scripts -type d -depth 1
lint-exec:
.for DIR in ${.CURDIR}/src/etc/rc.d ${.CURDIR}/src/etc/rc.syshook.d ${SCRIPTDIRS}
.if exists(${DIR})
@find ${DIR} -path '**/htdocs_default' -prune -o -type f \
! -name "*.xml" ! -name "*.csv" ! -name "*.sql" -print0 | \
xargs -0 -t -n1 test -x || \
(echo "Missing executable permission in ${DIR}"; exit 1)
.endif
.endfor
LINTBIN?= ${.CURDIR}/contrib/parallel-lint/parallel-lint
lint-php:
@${LINTBIN} src
lint: plist-check lint-shell lint-xml lint-exec lint-php
sweep:
find ${.CURDIR}/src -type f -name "*.map" -print0 | \
xargs -0 -n1 rm
if grep -nr sourceMappingURL= ${.CURDIR}/src; then \
echo "Mentions of sourceMappingURL must be removed"; \
exit 1; \
fi
find ${.CURDIR}/src ! -name "*.min.*" ! -name "*.svg" \
! -name "*.ser" -type f -print0 | \
xargs -0 -n1 ${.CURDIR}/Scripts/cleanfile
find ${.CURDIR}/Scripts ${.CURDIR}/.github -type f -print0 | \
xargs -0 -n1 ${.CURDIR}/Scripts/cleanfile
find ${.CURDIR} -type f -depth 1 -print0 | \
xargs -0 -n1 ${.CURDIR}/Scripts/cleanfile
STYLEDIRS?= src/etc/inc src/opnsense
style-python: want-py${CORE_PYTHON}-pycodestyle
@pycodestyle-${CORE_PYTHON_DOT} --ignore=E501 ${.CURDIR}/src || true
style-php: want-php${CORE_PHP}-pear-PHP_CodeSniffer
@: > ${WRKDIR}/style.out
.for STYLEDIR in ${STYLEDIRS}
@(phpcs --standard=ruleset.xml ${.CURDIR}/${STYLEDIR} \
|| true) >> ${WRKDIR}/style.out
.endfor
@echo -n "Total number of style warnings: "
@grep '| WARNING' ${WRKDIR}/style.out | wc -l
@echo -n "Total number of style errors: "
@grep '| ERROR' ${WRKDIR}/style.out | wc -l
@cat ${WRKDIR}/style.out | ${PAGER}
@rm ${WRKDIR}/style.out
style-fix: want-php${CORE_PHP}-pear-PHP_CodeSniffer
.for STYLEDIR in ${STYLEDIRS}
phpcbf --standard=ruleset.xml ${.CURDIR}/${STYLEDIR} || true
.endfor
style: style-python style-php
license: want-p5-File-Slurp
@${.CURDIR}/Scripts/license > ${.CURDIR}/LICENSE
sync: license plist-fix
ARGS= diff mfc
# handle argument expansion for required targets
.for TARGET in ${.TARGETS}
_TARGET= ${TARGET:C/\-.*//}
.if ${_TARGET} != ${TARGET}
.for ARGUMENT in ${ARGS}
.if ${_TARGET} == ${ARGUMENT}
${_TARGET}_ARGS+= ${TARGET:C/^[^\-]*(\-|\$)//:S/,/ /g}
${TARGET}: ${_TARGET}
.endif
.endfor
${_TARGET}_ARG= ${${_TARGET}_ARGS:[0]}
.endif
.endfor
ensure-stable:
@if ! git show-ref --verify --quiet refs/heads/${CORE_STABLE}; then \
git update-ref refs/heads/${CORE_STABLE} refs/remotes/origin/${CORE_STABLE}; \
git config branch.${CORE_STABLE}.merge refs/heads/${CORE_STABLE}; \
git config branch.${CORE_STABLE}.remote origin; \
fi
diff: ensure-stable
@if [ "$$(git tag -l | grep -cx '${diff_ARGS:[1]}')" = "1" ]; then \
git diff --stat -p ${diff_ARGS:[1]}; \
else \
git diff --stat -p ${CORE_STABLE} ${.CURDIR}/${diff_ARGS:[1]}; \
fi
mfc: ensure-stable clean-mfcdir
.for MFC in ${mfc_ARGS}
.if exists(${MFC})
@cp -r ${MFC} ${MFCDIR}
@git checkout ${CORE_STABLE}
@rm -rf ${MFC}
@mkdir -p $$(dirname ${MFC})
@mv ${MFCDIR}/$$(basename ${MFC}) ${MFC}
@git add -f .
@if ! git diff --quiet HEAD; then \
git commit -m "${MFC}: sync with ${CORE_DEVEL}"; \
fi
.else
@git checkout ${CORE_STABLE}
@if ! git cherry-pick -x ${MFC}; then \
git cherry-pick --abort; \
fi
.endif
@git checkout ${CORE_DEVEL}
.endfor
stable:
@git checkout ${CORE_STABLE}
devel ${CORE_DEVEL}:
@git checkout ${CORE_DEVEL}
rebase:
@git checkout ${CORE_STABLE}
@git rebase -i
@git checkout ${CORE_DEVEL}
log: ensure-stable
@git log --stat -p ${CORE_STABLE}
push:
@git checkout ${CORE_STABLE}
@git push
@git checkout ${CORE_DEVEL}
migrate:
@src/opnsense/mvc/script/run_migrations.php
test: want-phpunit7-php${CORE_PHP}
@if [ "$$(${VERSIONBIN} -v)" != "${CORE_PKGVERSION}" ]; then \
echo "Installed version does not match, expected ${CORE_PKGVERSION}"; \
exit 1; \
fi
@cd ${.CURDIR}/src/opnsense/mvc/tests && \
phpunit --configuration PHPunit.xml
checkout:
@${GIT} reset -q ${.CURDIR}/src && \
${GIT} checkout -f ${.CURDIR}/src && \
${GIT} clean -xdqf ${.CURDIR}/src
clean-pkgdir:
@rm -rf ${PKGDIR}
@mkdir -p ${PKGDIR}
clean-mfcdir:
@rm -rf ${MFCDIR}
@mkdir -p ${MFCDIR}
clean-wrksrc:
@rm -rf ${WRKSRC}
@mkdir -p ${WRKSRC}
clean: clean-pkgdir clean-wrksrc clean-mfcdir
.PHONY: license plist