LICENSE

-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.

Makefile

@@ -15,39 +15,23 @@ include package/targets.mak
 
 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)

NEWS.md

@@ -2,6 +2,58 @@
 
 ---
 
+# 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

INSTALL.md → README.md

@@ -17,9 +17,8 @@ You can customize paths via flags given to configure. See `./configure --help` f
 
 ## Runtime dependencies
 
-- execline version 2.7.0.0 or later: http://skarnet.org/software/execline/
-- s6 version 2.10.0.0 or later: http://skarnet.org/software/s6/
-- 66 version 0.6.0.0 or later https://framagit.org/Obarun/66/
-- 66-tools version 0.0.7.0 or later https://framagit.org/Obarun/66-tools/
-- optional dependencies:
-  * dbus-66serv version 0.2.0 or later https://framagit.org/pkg/observice/dbus-66serv
+- 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/
+

configure

@@ -16,18 +16,18 @@ Fine tuning of the installation directories:
   --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]
- 
+
 Fine tunning of scandir configuration:
   --LOGGER=BOOLEAN                 create an associated logger [!yes]
   --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.
- 
+
  Empty value is a commented one and not used at all.
 
  An exclamation mark '!' at the begin of the value unexport the variable
@@ -91,13 +91,13 @@ exec_prefix='$prefix'
 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
@@ -107,13 +107,13 @@ for arg ; do
     --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 ;;
@@ -130,14 +130,14 @@ fi
 # 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
@@ -174,14 +174,13 @@ cat << EOF
 # 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

module/scandir@/configure/configure → module/configure/configure

-#!@BINDIR@/sh
+#!%%BINDIR%%/sh
 
 ## 66-yeller variable
 export PROG="${MOD_NAME}"
@@ -6,23 +6,24 @@ 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
 }
 
-owner="${1}"
-home_env=$(homeof "${owner}" 2>/dev/null)
-
 if [ -z "${home_env}" ]; then
     die "invalid user: ${owner}"
 fi
 
-home_env="${home_env}/${MOD_SERVICE_USERCONFDIR}svscan@${owner}"
-
-service_dir="${MOD_MODULE_DIR}/service@"
-svscan="${service_dir}/svscan@"
-
 check_empty_var(){
     name="${1}" var_value="${2}"
     if [ -z "${var_value}" ]; then
@@ -39,10 +40,9 @@ disable() {
 enable() {
     name=${1}
     66-yeller %benable%n service: "${name}"
-    touch "${MOD_MODULE_DIR}/service/${name}"
+    touch "${ACTIVATED_PATH}/${name}"
 }
 
-
 absolute_path(){
     name="${1}" var="${2}"
     if [ "$(66-yeller -i "${var}" | cut -c 1)" != "/" ]; then
@@ -50,8 +50,6 @@ absolute_path(){
     fi
 }
 
-
-
 if execl-toc -X -V LIVE_DIRECTORY; then
 
     check_empty_var "LIVE_DIRECTORY" "${LIVE_DIRECTORY}"
@@ -59,41 +57,40 @@ if execl-toc -X -V LIVE_DIRECTORY; then
     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"
+    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:@LIVE_DIR@:-l ${MOD_LIVE}:" "${svscan}" || die "unable to set the live directory to use"
+    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:@PATH_ENVIRONMENT@:${home_env}:g" "${service_dir}/setenv@" || die "unable to set environment directory to use"
+    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"
+    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"
+    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"
+    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"
+    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"
+sed -i "s:%%verbosity_level%%:-v${VERBOSITY_LEVEL}:" "${svscan}" || die "unable to set verbosity"
 
 66-yeller "%bsuccessfully%n configured"

module/scandir@/service@/setenv@ → module/frontend/setenv@

-[main]
-@type = oneshot
-@version = @version@
-@description = "Set well-know variables for @I user"
-@user = ( root )
-
-[start]
-@runas = @I
-@execute =
+[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 @PATH_ENVIRONMENT@
+    execl-toc -v3 -d %%environment_path%%
 
-    redirfd -w 1 @PATH_ENVIRONMENT@/svscan@@I
+    redirfd -w 1 %%environment_path%%/.svscan@@I
 
     ## GENERAL VARIABLES
 

module/frontend/svscan@

+[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

service/scandir@ → module/scandir@

-[main]
-@type = module
-@version = @VERSION@
-@description = "Create a nested scandir for @I"
-@user = ( root )
-
-[regex]
-@configure="@I"
-@files = ( @M=@I )
-@infiles = (
-::@version@=@VERSION@ )
-
-[environment]
+[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@
+## If commented the default is %%LIVEDIR%%
 
-#LIVE_DIRECTORY=@LIVEDIR@
+#LIVE_DIRECTORY=%%LIVEDIR%%
 
 ## Create an associated logger [yes|no]
 
-@LOGGER@
+%%LOGGER%%
 
 ## Launch the scandir with a environment [yes|no].
-## The environment directory is: $HOME/@USER_CONF_DIR@/svscan@@I
+## The environment directory is: $HOME/%%USER_CONF_DIR%%/svscan@@I
 
-@USE_ENVIRONMENT@
+%%USE_ENVIRONMENT%%
 
 ## Use notification [yes|no]
 
-@NOTIFY@
+%%NOTIFY%%
 
-## Level of verbosity [0-4]
+## Level of verbosity [0-5]
 
-@VERBOSITY_LEVEL@
+%%VERBOSITY_LEVEL%%

module/scandir@/service@/svscan@

-[main]
-@type = longrun
-@version = @version@
-@description = "Create and start a nested scandir for @I"
-@user = ( root )
-@depends = ( setenv@@I )
-#@options = ( !log )
-@notify = 3
-@timeout-up = 3000
-
-[start]
-@runas = @I
-@execute = (
-    s6-setsid -qb --
-    umask 022
-    if {
-        execl-cmdline -s { 66-scandir ${cmd_args_scandir} create }
-    }
-    execl-cmdline -s { 66-scanctl ${cmd_args_scanctl} start }
-)
-
-[stop]
-@runas = @I
-@execute = (
-    66-scanctl @LIVE_DIR@ stop
-)
-
-[environment]
-cmd_args_scandir=!@VERBOSITY_LEVEL@ @LIVE_DIR@
-cmd_args_scanctl=!@VERBOSITY_LEVEL@ @NOTIFY@ @LIVE_DIR@ @USE_ENVIRONMENT@

package/info

-package=scandir-66serv
-version=0.2.1
+package=scandir
+version=0.8.1
 package_macro_dir=66

package/targets.mak

-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)