Compare revisions

Copyright (c) 2015-2020 Eric Vidal <eric@obarun.org>

Copyright (c) 2024 Eric Vidal <eric@obarun.org>

All rights reserved.

Permission to use, copy, modify, and/or distribute this software for any

purpose with or without fee is hereby granted, provided that the above

copyright notice and this permission notice appear in all copies.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 

MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 

WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

INSTALL := ./tools/install.sh

install: install-script install-service install-service-module install-service-instance-module install-configure

install-script: $(SCRIPT_TARGET:module/scandir@/configure/%=$(DESTDIR)$(module_directory)/scandir@/configure/%)

install-service: $(SERVICE_TARGET:service/%=$(DESTDIR)$(service_directory)/%)

install-service-module: $(MODULE_TARGET:module/scandir@/service/%=$(DESTDIR)$(module_directory)/scandir@/service/%)

install-service-instance-module: $(MODULE_INSTANCE_TARGET:module/scandir@/service@/%=$(DESTDIR)$(module_directory)/scandir@/service@/%)

install-configure: $(MODULE_CONFIGURE_TARGET:module/scandir@/configure/configure=$(DESTDIR)$(module_directory)/scandir@/configure/configure)

install: install-module install-script

install-module: $(MODULE_TARGET:module/%=$(DESTDIR)$(service_directory)/$(package)/%)

install-script: $(SCRIPT_TARGET:module/configure/%=$(DESTDIR)$(service_directory)/$(package)/configure/%)

$(DESTDIR)$(module_directory)/scandir@/configure/%: module/scandir@/configure/%

	exec $(INSTALL) -D -m 755 $< $@

	sed -i -e 's,@BINDIR@,$(bindir),' $@

$(DESTDIR)$(module_directory)/scandir@/configure/configure: module/scandir@/configure/configure

	exec $(INSTALL) -D -m 755 $< $@

	sed -i -e 's,@BINDIR@,$(bindir),' $@

$(DESTDIR)$(module_directory)/scandir@/service/%: module/scandir@/service/%

	exec $(INSTALL) -D -m 644 $< $@

$(DESTDIR)$(module_directory)/scandir@/service@/%: module/scandir@/service@/%

	exec $(INSTALL) -D -m 644 $< $@

$(DESTDIR)$(service_directory)/%: service/%

$(DESTDIR)$(service_directory)/$(package)/%: module/%

	exec $(INSTALL) -D -m 644 $< $@

	sed -i -e 's,@VERSION@,$(version),' \

		-e "s,@LIVEDIR@,$(livedir)," \

		-e "s,@USER_CONF_DIR@,$(service_userconf)," \

		-e "s,@LOGGER@,$(LOGGER)," \

		-e "s,@USE_ENVIRONMENT@,$(USE_ENVIRONMENT)," \

		-e "s,@VERBOSITY_LEVEL@,$(VERBOSITY_LEVEL)," \

		-e "s,@NOTIFY@,$(NOTIFY)," $@

	sed -i -e 's,%%VERSION%,$(version),' \

		-e "s,%%LIVEDIR%%,$(livedir)," \

		-e "s,%%USER_CONF_DIR%%,$(service_userconf)," \

		-e "s,%%LOGGER%%,$(LOGGER)," \

		-e "s,%%USE_ENVIRONMENT%%,$(USE_ENVIRONMENT)," \

		-e "s,%%VERBOSITY_LEVEL%%,$(VERBOSITY_LEVEL)," \

		-e "s,%%NOTIFY%%,$(NOTIFY)," $@

$(DESTDIR)$(service_directory)/$(package)/configure/%: module/configure/%

	exec $(INSTALL) -D -m 755 $< $@

	sed -i -e 's,%%BINDIR%%,$(bindir),' $@

version:

	@echo $(version)

---

# In 0.8.1

- Bugfix: use of new keyword format at `[Regex]` section

---

# In 0.8.0

- Adapt to new format of 66 release 0.8.0

---

# In 0.4.3

- Fix seed directory replacement at documentation page.

- Avoid conflicting identifier between Makefile and 66 identifier for frontend file.

- Prepare for the next 66 release.

---

# In 0.4.2

- Adapt to 66 version 0.7.0 stable

- Allow to declare version at configure invocation

---

# In 0.4.1

- Adapt to 66 0.7.0.0-beta2

- Fix replacement of variable value

---

# In 0.4.0

- Adapt to execline 2.9.4.0

- Adapt to 66 0.7.0.0-beta

- Adapt to 66-tools 0.1.0.0

---

# In 0.3.1

- Follow 66 envfile behavior: the $HOME/.66/svscan@<user>/.svscan@<user> is now created with a dot.

---

# In 0.3.0

- Adapt to execline 2.7.0.0

- Adapt to 66 0.6.0.0

---

# In 0.2.1

- Convenient release to udpate dependencies:

    - 66 v0.5.1.0

    - 66-tools v0.0.6.2

    - optional dependency:

        - dbus-66serv 0.2.0 for environment configuration

---

# In 0.2.0

- Adapt to 66 v0.4.0.1

---

# In 0.1.0

- first commit

## Runtime dependencies

- execline version 2.6.0.2 or later: http://skarnet.org/software/execline/

- s6 version 2.9.1.0 or later: http://skarnet.org/software/s6/

- 66 version 0.4.0.0 or later https://framagit.org/Obarun/66/

- 66-tools version 0.0.5.0 or later https://framagit.org/Obarun/66-tools/

- execline version 2.9.6.1 or later: http://skarnet.org/software/execline/

- s6 version 2.13.1.0 or later: http://skarnet.org/software/s6/

- 66 version 0.8.0.0 or later: https://git.obarun.org/Obarun/66/

- 66-tools version 0.1.1.0 or later: https://git.obarun.org/Obarun/66-tools/

  --bindir=BINDIR                  user executables [EPREFIX/bin]

  --datarootdir=DATAROOTDIR        read-only architecture-independent data root [PREFIX/share]

  --with-system-service=DIR        66 service intallation directory [DATAROOTDIR/$package_macro_dir/service]

  --with-system-module=DIR         66 module intallation directory [DATAROOTDIR/$package_macro_dir/module]

  --livedir=DIR                    66 default live directory [/run/66]

  --with-user-service-conf=DIR     66 user service configuration directory [.66/conf]

  --USE_ENVIRONMENT=BOOLEAN        Launch the scandir with a environment [!yes]

  --NOTIFY=BOOLEAN                 use notification [!yes]

  --VERBOSITY_LEVEL=BOOLEAN        level of verbosity [!3]

  --version=VALUE                  version of the service[0.0.1]

 Use yes or no with lowercase character to set BOOLEAN values.

bindir='$exec_prefix/bin'

datarootdir='$prefix/share'

service_directory='$datarootdir/$package_macro_dir/service'

module_directory='$datarootdir/$package_macro_dir/module'

livedir='/run/66'

service_userconf='.66/conf'

LOGGER='!yes'

USE_ENVIRONMENT='!yes'

NOTIFY='!yes'

VERBOSITY_LEVEL='!3'

version='0.4.3'

for arg ; do

  case "$arg" in

    --bindir=*) bindir=${arg#*=} ;;

    --datarootdir=*) datarootdir=${arg#*=} ;;

    --with-system-service=*) service_directory=${arg#*=} ;;

    --with-system-module=*) module_directory=${arg#*=} ;;

    --livedir=*) livedir=${arg#*=} ;;

    --with-user-service-conf=*) service_userconf=${arg#*=} ;;

    --LOGGER=*) LOGGER=${arg#*=} ;;

    --USE_ENVIRONMENT=*) USE_ENVIRONMENT=${arg#*=} ;;

    --NOTIFY=*) NOTIFY=${arg#*=} ;;

    --VERBOSITY_LEVEL=*) VERBOSITY_LEVEL=${arg#*=} ;;

    --version=*) version=${arg#*=} ;;

    -* ) echo "$0: unknown option $arg" ;;

    *=*) ;;

    *) target=$arg ;;

# Expand installation directories

stripdir prefix

for i in exec_prefix bindir datarootdir \

		livedir service_directory module_directory ; do

		livedir service_directory; do

  eval tmp=\${$i}

  eval $i=$tmp

  stripdir $i

done

stripdir datarootdir

for i in service_directory module_directory; do

for i in service_directory; do

  eval tmp=\${$i}

  eval $i=$tmp

  stripdir $i

# This file was generated by:

# $cmdline

# Any changes made here will be lost if configure is re-run.

version := $version

package := $package

prefix := $prefix

exec_prefix := $exec_prefix

bindir := $bindir

datarootdir := $datarootdir

service_directory := $service_directory

module_directory := $module_directory

package_macro_dir := $package_macro_dir

livedir := $livedir

service_userconf := $service_userconf

#!%%BINDIR%%/sh

## 66-yeller variable

export PROG="${MOD_NAME}"

export VERBOSITY="${MOD_VERBOSITY}"

export CLOCK_ENABLED=0

export COLOR_ENABLED="${MOD_COLOR}"

## script variable

FRONTEND_PATH="${MOD_MODULE_DIR}/frontend"

ACTIVATED_PATH="${MOD_MODULE_DIR}/activated"

owner="${1}"

home_env=$(homeof "${owner}" 2>/dev/null)

home_env="${home_env}/${MOD_SERVICE_USERCONFDIR}svscan@${owner}"

svscan="${FRONTEND_PATH}/svscan@"

die(){

  66-yeller -f "${@}"

  exit 111

}

if [ -z "${home_env}" ]; then

    die "invalid user: ${owner}"

fi

check_empty_var(){

    name="${1}" var_value="${2}"

    if [ -z "${var_value}" ]; then

        die invalid value for variable: "${name}"

    fi

}

disable() {

    name=${1}

    66-yeller %rdisable%n service: "${name}"

    sed -i "s:${name}:#${name}:g" "${svscan}" || die "unable to sed ${service_dir}/scandir@"

}

enable() {

    name=${1}

    66-yeller %benable%n service: "${name}"

    touch "${ACTIVATED_PATH}/${name}"

}

absolute_path(){

    name="${1}" var="${2}"

    if [ "$(66-yeller -i "${var}" | cut -c 1)" != "/" ]; then

        die "${name}" must be an absolute path

    fi

}

if execl-toc -X -V LIVE_DIRECTORY; then

    check_empty_var "LIVE_DIRECTORY" "${LIVE_DIRECTORY}"

    absolute_path "LIVE_DIRECTORY" "${LIVE_DIRECTORY}"

    66-yeller set live directory to: %b"${LIVE_DIRECTORY}"%n

    sed -i "s:%%livedir%%:-l ${LIVE_DIRECTORY}:" "${svscan}" || die "unable to set the live directory to use"

else

    66-yeller set live directory to: %b${MOD_LIVE}%n

    sed -i "s:%%livedir%%:-l ${MOD_LIVE}:" "${svscan}" || die "unable to set the live directory to use"

fi

if [ "${USE_ENVIRONMENT}" = yes ]; then

    enable "setenv@${owner}"

    sed -i "s:%%use_environment%%:-e ${home_env}:" "${svscan}" || die "unable to set environment directory to use"

    sed -i "s:%%environment_path%%:${home_env}:g" "${FRONTEND_PATH}/setenv@" || die "unable to set environment directory to use"

else

    disable "setenv@@I"

    sed -i "s:%%use_environment%%::" "${svscan}" || die "unable to set environment directory to use"

fi

if [ "${LOGGER}" != "yes" ]; then

    66-yeller %rdisable%n logger options

    sed -i "s:log:!log:" "${svscan}" || die "unable to disable log options"

else

    66-yeller %benable%n logger options

fi

if [ "${NOTIFY}" != "yes" ]; then

    66-yeller %rdisable%n notification

    sed -i "s:%%notify%%::" "${svscan}" || die "unable to disable notification"

    sed -i "s:Notify:#Notify:" "${svscan}" || die "unable to disable notification"

else

    66-yeller %benable%n notification

    sed -i "s:%%notify%%:-d3:" "${svscan}" || die "unable to enable notification"

fi

66-yeller set verbosity level to: %b"${VERBOSITY_LEVEL}"%n

sed -i "s:%%verbosity_level%%:-v${VERBOSITY_LEVEL}:" "${svscan}" || die "unable to set verbosity"

66-yeller "%bsuccessfully%n configured"

[Main]

Type = oneshot

Version = %%version%%

Description = "Set well-know variables for @I user"

User = ( root )

[Start]

RunAs = @I

Execute =

(

    execl-subuidgid

    backtick -n HOME { homeof @I }

    importas -u HOME HOME

    execl-toc -v3 -d %%environment_path%%

    redirfd -w 1 %%environment_path%%/.svscan@@I

    ## GENERAL VARIABLES

    if { 66-echo -- HOME=${HOME} }

    if { 66-echo -- LOGNAME=@I }

    if { 66-echo -- USER=@I }

    foreground {

        importas PATH PATH

        66-echo -- PATH=${PATH}

    }

    foreground {

        backtick -D /usr/bin/sh -E shell {

            pipeline { getent passwd ${UID} }

            cut -d: -f7

        }

        66-echo -- SHELL=${shell}

    }

    foreground

    {

        backtick -E x

        {

            sh -c "d=0 ; while true ; do \

            if [ ! -e "/tmp/.X$d-lock" -o -S "/tmp/.X11-unix/X$d" ]; then \

                66-echo -- $d ; \

                break ; \

            fi ; \

            d=$(($d + 1)) ; \

            done ;"

        }

        66-echo -- DISPLAY=:${x}

    }

    ## DBUS

    if { 66-echo -- DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/${UID}/bus }

    ## XDG variables

    if { 66-echo -- XDG_RUNTIME_DIR=/run/user/${UID} }

    if { 66-echo -- XDG_CACHE_HOME=${HOME}/.cache }

    if { 66-echo -- XDG_CONFIG_HOME=${HOME}/.config }

    if { 66-echo -- XDG_DATA_HOME=${HOME}/.local/share }

    if { 66-echo -- XDG_DATA_DIRS=${HOME}/.local/share:/usr/local/share:/usr/share }

    66-echo -- XDG_SESSION_CLASS=user

)

[Main]

Type = classic

Version = %%version%%

Description = "Create and start a nested scandir for @I"

User = ( root )

Depends = ( setenv@@I )

Notify = 3

TimeoutStart = 3000

Options = ( log )

[Start]

RunAs = @I

Execute = (

    s6-setsid -qb --

    umask 022

    execl-cmdline -s { 66 ${Args66} scandir ${ArgsScandirStart} }

)

[Stop]

RunAs = @I

Execute = (

    execl-cmdline -s { 66 ${Args66} scandir ${ArgsScandirStop} }

)

[Environment]

Args66=!%%verbosity_level%% %%livedir%%

ArgsScandirStart=!start %%notify%% %%use_environment%%

ArgsScandirStop=!stop

[Main]

Type = module

Version = %%VERSION%

Description = "Create a nested scandir for @I"

User = ( root )

InTree = session

[Regex]

Configure="@I"

Files = ( @M=@I )

InFiles = (

::%%version%%=%%VERSION% )

[Environment]

## Run the scandir at LIVE_DIRECTORY.

## Need to be an absolute path.

## If commented the default is %%LIVEDIR%%

#LIVE_DIRECTORY=%%LIVEDIR%%

## Create an associated logger [yes|no]

%%LOGGER%%

## Launch the scandir with a environment [yes|no].

## The environment directory is: $HOME/%%USER_CONF_DIR%%/svscan@@I

%%USE_ENVIRONMENT%%

## Use notification [yes|no]

%%NOTIFY%%

## Level of verbosity [0-5]

%%VERBOSITY_LEVEL%%

#!@BINDIR@/sh

## 66-yeller variable

export PROG="${MOD_NAME}"

export VERBOSITY="${MOD_VERBOSITY}"

export CLOCK_ENABLED=0

owner="${1}"

home_env=$(homeof "${owner}")

home_env="${home_env}/${MOD_SERVICE_USERCONFDIR}svscan@${owner}"

service_dir="${MOD_MODULE_DIR}/service@"

svscan="${service_dir}/svscan@"

die(){

  66-yeller -f "${@}"

  exit 111

}

check_empty_var(){

	name="${1}" var_value="${2}"

	if [ -z "${var_value}" ]; then

		die invalid value for variable: "${name}"

	fi

}

disable() {

	name=${1}

	66-yeller %rdisable%n service: "${name}"

	sed -i "s:${name}:#${name}:g" "${svscan}" || die "unable to sed ${service_dir}/scandir@"

}

enable() {

	name=${1}

	66-yeller %benable%n service: "${name}"

	touch "${MOD_MODULE_DIR}/service/${name}"

}

absolute_path(){

	name="${1}" var="${2}"

	if [ "$(66-yeller -i "${var}" | cut -c 1)" != "/" ]; then

		die "${name}" must be an absolute path

	fi

}

if execl-toc -X -V LIVE_DIRECTORY; then

	check_empty_var "LIVE_DIRECTORY" "${LIVE_DIRECTORY}"

	absolute_path "LIVE_DIRECTORY" "${LIVE_DIRECTORY}"

	66-yeller set live directory to: %b"${LIVE_DIRECTORY}"%n

	sed -i "s:@LIVE_DIR@:-l ${LIVE_DIRECTORY}:" "${svscan}" || die "unable to set the live directory to use"

else

	66-yeller set live directory to: %b${MOD_LIVE}%n

	sed -i "s:@LIVE_DIR@:-l ${MOD_LIVE}:" "${svscan}" || die "unable to set the live directory to use"

fi

if [ "${USE_ENVIRONMENT}" = yes ]; then 

	enable "setenv@${owner}"

	sed -i "s:@USE_ENVIRONMENT@:-e ${home_env}:" "${svscan}" || die "unable to set environment directory to use"

	sed -i "s:@PATH_ENVIRONMENT@:${home_env}:g" "${service_dir}/setenv@" || die "unable to set environment directory to use"

else

	disable "setenv@@I"

	sed -i "s:@USE_ENVIRONMENT@::" "${svscan}" || die "unable to set environment directory to use"

fi

if [ "${LOGGER}" != "yes" ]; then

	66-yeller %rdisable%n logger options

	sed -i "s:@options:#@options:" "${svscan}" || die "unable to disable log options"

else

	66-yeller %benable%n logger options

fi

if [ "${NOTIFY}" != "yes" ]; then

	66-yeller %rdisable%n notification

	sed -i "s:@NOTIFY@::" "${svscan}" || die "unable to disable notification"

	sed -i "s:@notify:#@notify:" "${svscan}" || die "unable to disable notification"

else

	66-yeller %benable%n notification

	sed -i "s:@NOTIFY@:-d3:" "${svscan}" || die "unable to enable notification"

fi

66-yeller set verbosity level to: %b"${VERBOSITY_LEVEL}"%n

sed -i "s:@VERBOSITY_LEVEL@:-v${VERBOSITY_LEVEL}:" "${svscan}" || die "unable to disable log options"

66-yeller "%bsuccessfully%n configured"

[main]

@type = oneshot

@version = @version@

@description = "Set well-know variables for @I user"

@user = ( root )

@options = ( log )

[start]

@runas = @I

@execute = 

(

	execl-subuidgid

	backtick -n HOME { homeof @I }

	importas -u HOME HOME

	execl-toc -v3 -d @PATH_ENVIRONMENT@

	redirfd -w 1 @PATH_ENVIRONMENT@/svscan@@I

	## GENERAL VARIABLES

	if { 66-echo HOME=${HOME} }

	if { 66-echo LOGNAME=@I }

	if { 66-echo USER=@I }

	foreground { 

		importas PATH PATH 

		66-echo -- PATH=${PATH} 

	}

	foreground {

		backtick -D /usr/bin/sh -n shell {

			pipeline { getent passwd ${UID} }

			cut -d: -f7 

		}

		importas -u shell shell

		66-echo -- SHELL=${shell}

	}

	foreground 

	{

		backtick -n x 

		{

			sh -c "d=0 ; while true ; do \

			if [ ! -e "/tmp/.X$d-lock" -o -S "/tmp/.X11-unix/X$d" ]; then \

				66-echo -- $d ; \

				break ; \

			fi ; \

			d=$(($d + 1)) ; \

			done ;"

		}

		importas -u x x

		66-echo -- DISPLAY=:${x}  

	}

	## DBUS

	if { 66-echo -- DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/${UID}/bus }

	## XDG variables

	if { 66-echo -- XDG_RUNTIME_DIR=/run/user/${UID} }

	if { 66-echo -- XDG_CACHE_HOME=${HOME}/.cache }

	if { 66-echo -- XDG_CONFIG_HOME=${HOME}/.config }

	if { 66-echo -- XDG_DATA_HOME=${HOME}/.local/share }

	if { 66-echo -- XDG_DATA_DIRS=${HOME}/.local/share:/usr/local/share:/usr/share }

	66-echo -- XDG_SESSION_CLASS=user

)

[main]

@type = longrun

@version = @version@

@description = "Create and start a nested scandir for @I"

@user = ( root )

@options = ( log env )

@depends = ( setenv@@I )

@notify = 3

@timeout-up = 3000

[start]

@runas = @I

@execute =

(

s6-setsid -qb --

umask 022

execl-cmdline -s { 66-scandir ${cmd_args} -cu }

)

[environment]

cmd_args=!@VERBOSITY_LEVEL@ @NOTIFY@ @LIVE_DIR@ @USE_ENVIRONMENT@

package=scandir-66serv

version=0.1.0

package=scandir

version=0.8.1

package_macro_dir=66

SCRIPT_TARGET :=

SERVICE_TARGET := service/scandir@

MODULE_TARGET := $(shell find module/scandir@/service -type f)

MODULE_INSTANCE_TARGET := $(shell find module/scandir@/service@ -type f)

MODULE_CONFIGURE_TARGET := module/scandir@/configure/configure

SCRIPT_TARGET := module/configure/configure

MODULE_TARGET := $(shell find module/ -type f)

[main]

@type = module

@version = @VERSION@

@description = "Create a nested scandir for @I"

@user = ( root )

@options = ( env )

[regex]

@configure="@I"

@files = ( @M=@I )

@infiles = (

:setenv@:@version@=@VERSION@

:svscan@:@version@=@VERSION@ )

[environment]

## Run the scandir at LIVE_DIRECTORY.

## Need to be an absolute path.

## If commented the default is @LIVEDIR@

#LIVE_DIRECTORY=@LIVEDIR@

## Create an associated logger [yes|no]

@LOGGER@

## Launch the scandir with a environment [yes|no].

## The environment directory is: $HOME/@USER_CONF_DIR@/svscan@@I

@USE_ENVIRONMENT@

## Use notification [yes|no]

@NOTIFY@

## Level of verbosity [0-4]

@VERBOSITY_LEVEL@