commit: 1aeb74d3fa80f3c5076dc86f84a4588e7ee4d4c5 Author: Anna (cybertailor) Vyalkova <cyber+gentoo <AT> sysrq <DOT> in> AuthorDate: Thu Jul 22 08:10:21 2021 +0000 Commit: Anna Vyalkova <cyber+gentoo <AT> sysrq <DOT> in> CommitDate: Thu Jul 22 08:27:39 2021 +0000 URL: https://gitweb.gentoo.org/repo/proj/guru.git/commit/?id=1aeb74d3
boinc-app.eclass: new eclass Signed-off-by: Anna (cybertailor) Vyalkova <cyber+gentoo <AT> sysrq.in> eclass/boinc-app.eclass | 308 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 308 insertions(+) diff --git a/eclass/boinc-app.eclass b/eclass/boinc-app.eclass new file mode 100644 index 000000000..d62c8a91f --- /dev/null +++ b/eclass/boinc-app.eclass @@ -0,0 +1,308 @@ +# Copyright 2021 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +# @ECLASS: boinc-app.eclass +# @MAINTAINER: +# Anna Vyalkova <[email protected]> +# @SUPPORTED_EAPIS: 8 +# @BLURB: Eclass that provides base functions for installing BOINC applications. +# @DESCRIPTION: +# This eclass provides base functions for installation of software developed +# for the BOINC platform. +# +# Do not package *-bin applications as BOINC can handle them itself better. +# +# Note that BOINC won't detect a custom application unless you provide it with +# app_info.xml file (see https://boinc.berkeley.edu/wiki/Anonymous_platform). +# Attach to a project of your interest and use values from +# /var/lib/boinc/client_state.xml to write the file. +# +# BOINC.Italy did a great job discovering sources of many BOINC applications: +# https://www.boincitaly.org/progetti/sorgenti-progetti.html + +case ${EAPI} in + 8) ;; + *) die "${ECLASS}: EAPI ${EAPI} unsupported." +esac + +# @ECLASS-VARIABLE: BOINC_APP_OPTIONAL +# @DEFAULT_UNSET +# @DESCRIPTION: +# If set to a non-null value, BOINC part in the ebuild will be +# considered optional and no phase functions will be exported. +# +# If you enable BOINC_APP_OPTIONAL, you have to call boinc-app +# default phase functions and add dependencies manually. + +if [[ ! ${BOINC_APP_OPTIONAL} ]]; then + EXPORT_FUNCTIONS pkg_postinst pkg_postrm +fi + +if [[ ! ${_BOINC_APP_ECLASS} ]]; then + +# @ECLASS-VARIABLE: BOINC_MASTER_URL +# @REQUIRED +# @DESCRIPTION: +# Each project is publicly identified by a master URL. It also serves +# as the home page of the project. +# +# You need to look it up using the following command: +# @CODE +# grep "<master_url>" /var/lib/boinc/client_state.xml +# @CODE + +# @ECLASS-VARIABLE: BOINC_INVITATION_CODE +# @DEFAULT_UNSET +# @DESCRIPTION: +# Some projects restrict account creation to those who present an +# "invitation code". Write it to BOINC_INVITATION_CODE variable if +# it's published on project's website. + +# @ECLASS-VARIABLE: HOMEPAGE +# @DESCRIPTION: +# This variable defines the HOMEPAGE for BOINC projects if BOINC_MASTER_URL +# was set before inherit. +: ${HOMEPAGE:=${BOINC_MASTER_URL}} + +# @ECLASS-VARIABLE: BOINC_APP_HELPTEXT +# @DESCRIPTION: +# Help message to display during the pkg_postinst phase +: ${BOINC_APP_HELPTEXT:=\ +You have to attach to the corresponding project +in order to use this application with BOINC.} + +# @FUNCTION: boinc-app_add_deps +# @USAGE: [--wrapper] +# @DESCRIPTION: +# Generate appropriate (R)DEPEND for wrapper-enabled or +# native application. +boinc-app_add_deps() { + if [[ $1 == "--wrapper" ]]; then + RDEPEND="sci-misc/boinc-wrapper" + else + DEPEND="sci-misc/boinc" + RDEPEND="sci-misc/boinc" + fi +} + +# @FUNCTION: boinc_master_url_check +# @USAGE: +# @DESCRIPTION: +# Make sure BOINC_MASTER_URL has a value. +boinc_master_url_check() { + [[ ! ${BOINC_MASTER_URL} ]] && \ + die "BOINC_MASTER_URL is not set" + return 0 +} + +# @FUNCTION: get_boincdir +# @USAGE: +# @RETURN: non-prefixed default BOINC runtime directory +get_boincdir() { + echo /var/lib/boinc +} + +# @FUNCTION: get_project_dirname +# @INTERNAL +# @USAGE: +# @RETURN: project's dirname, derived from BOINC_MASTER_URL +# @DESCRIPTION: +# Example: +# +# @CODE +# BOINC_MASTER_URL="https://boinc.berkeley.edu/example/"; +# get_project_dirname +# -> boinc.berkeley.edu_example +# @CODE +get_project_dirname() { + boinc_master_url_check + + local dirname + dirname=${BOINC_MASTER_URL#*://} # strip http[s]:// + dirname=${dirname%/} # strip trailing slash + dirname=${dirname////_} # replace '/' with '_' + + echo "${dirname}" +} + +# @FUNCTION: get_project_root +# @USAGE: +# @RETURN: non-prefixed directory where applications and files should be installed +get_project_root() { + echo "$(get_boincdir)/projects/$(get_project_dirname)" +} + +# @FUNCTION: boinc-app_appinfo_prepare +# @USAGE: <writable app_info.xml> +# @DESCRIPTION: +# The default appinfo_prepare(). It replaces all occurences +# of @PV@ with its corresponding value. +boinc-app_appinfo_prepare() { + sed -i "$1" \ + -e "s:%PV%:${PV}:g" \ + || die "app_info.xml sed failed" +} + +# @FUNCTION: doappinfo +# @USAGE: <app_info.xml> +# @DESCRIPTION: +# Installs given app_info.xml file to the project root. +# +# Tip: implement appinfo_prepare() function for all your sed hacks. +# It should recognize first argument as a file and edit it in place. +# +# Example: +# @CODE +# appinfo_prepare() { +# if ! use cuda; then +# sed "/<plan_class>cuda/d" -i "$1" || die +# fi +# boinc-app_appinfo_prepare "$1" +# } +# +# src_install() { +# doappinfo "${FILESDIR}"/app_info_${PV}.xml +# +# exeinto $(get_project_root) +# exeopts -m 0755 --owner boinc --group boinc +# newexe bin/${PN} example_app_v${PV} +# } +# @CODE +doappinfo() { + (( $# == 1 )) || \ + die "${FUNCNAME} takes exactly one argument" + + cp "$1" "${T}"/app_info.xml || die + + if declare -f appinfo_prepare >/dev/null; then + appinfo_prepare "${T}"/app_info.xml + else + boinc-app_appinfo_prepare "${T}"/app_info.xml + fi + + ( # subshell to avoid pollution of calling environment + insinto $(get_project_root) + insopts -m 0644 --owner boinc --group boinc + doins "${T}"/app_info.xml + ) || die "failed to install app_info.xml" +} + +# @FUNCTION: boinc-wrapper_foreach_wrapper_job +# @USAGE: <job.xml> +# @DESCRIPTION: +# The default foreach_wrapper_job(). It replaces all occurences +# of @PV@, @EPREFIX@ and @LIBDIR@ strings with their corresponding values. +boinc-wrapper_foreach_wrapper_job() { + sed -i "$1" \ + -e "s:@PV@:${PV}:g" \ + -e "s:@EPREFIX@:${EPREFIX}:g" \ + -e "s:@LIBDIR@:$(get_libdir):g" \ + || die "$(basename "$1") sed failed" +} + +# @FUNCTION: dowrapper +# @USAGE: <app> [more apps...] +# @DESCRIPTION: +# This function provides a uniform way to install wrapper applications +# for BOINC projects. It makes symlinks to the BOINC wrapper and also +# installs respective job.xml files. +# +# When sci-misc/boinc-example-1.0 calls `dowrapper boinc-example` it: +# +# 1. Installs boinc-example_job_1.0.xml from ebuild's files/ directory +# to project's root directory +# +# 2. Installs boinc-example_wrapper_1.0 symlink, which points +# to /usr/bin/boinc-wrapper, to project's root directory +# +# Example: +# @CODE +# src_install() { +# meson_src_install +# +# dowrapper boinc-example boinc-sample +# doappinfo "${FILESDIR}"/app_info_${PV}.xml +# } +# @CODE +# +# Keep your job.xml files in sync with app_info.xml! +dowrapper() { + for app in "$@"; do + local wrapperjob="${app}_job_${PV}.xml" + local wrapperexe="${app}_wrapper_${PV}" + + [[ -f "${FILESDIR}/${wrapperjob}" ]] || \ + die "${wrapperjob} not found in ebuild's files/ directory" + + cp "${FILESDIR}/${wrapperjob}" "${T}" || die + + if declare -f foreach_wrapper_job >/dev/null; then + foreach_wrapper_job "${T}/${wrapperjob}" + else + boinc-wrapper_foreach_wrapper_job "${T}/${wrapperjob}" + fi + + ( # subshell to avoid pollution of calling environment + insinto $(get_project_root) + insopts -m 0644 --owner boinc --group boinc + doins "${T}"/${wrapperjob} + dosym -r /usr/bin/boinc-wrapper "$(get_project_root)/${wrapperexe}" + ) || die "failed to install '${app}' wrapper app" + done +} + +# @FUNCTION: boinc-app_pkg_postinst +# @DESCRIPTION: +# Display helpful instructions on how to make the BOINC client use installed +# applications. +boinc-app_pkg_postinst() { + if [[ -f "${EROOT}$(get_boincdir)/master_$(get_project_dirname).xml" ]]; then + if [[ ! ${REPLACING_VERSIONS} ]]; then + # most likely replacing applications downloaded + # by the BOINC client from project's website + elog "Restart the BOINC daemon for changes to take place:" + elog "# rc-service boinc restart" + return + else + # applications are already in use + return + fi + fi + + elog + while read h; do + elog "${h}" + done <<<"${BOINC_APP_HELPTEXT}" + elog + + if [[ ! ${BOINC_INVITATION_CODE} ]]; then + elog "# rc-service boinc attach" + elog " Enter the Project URL: ${BOINC_MASTER_URL}" + else + elog "- Master URL: ${BOINC_MASTER_URL}" + elog "- Invitation code: ${BOINC_INVITATION_CODE}" + fi +} + +# @FUNCTION: boinc-app_pkg_postrm +# @DESCRIPTION: +# Display helpful instructions on how to cleanly uninstall unmerged +# applications. +boinc-app_pkg_postrm() { + if [[ ! ${REPLACED_BY_VERSION} ]]; then + local gui_rpc_auth="$(get_boincdir)/gui_rpc_auth.cfg" + local passwd=$(cat "${EROOT}${gui_rpc_auth}") + if [[ ! ${passwd} ]]; then + passwd="\$(cat ${gui_rpc_auth})" + fi + + elog + elog "You should detach this project from the BOINC client" + elog "to stop current tasks and delete remaining project files:" + elog + elog "$ boinccmd --passwd ${passwd} --project ${BOINC_MASTER_URL} detach" + fi +} + +_BOINC_APP_ECLASS=1 +fi
