Generate afm-unit.conf using m4

The use of m4 to generate the afm-unit.conf and
afm-unit-debug.conf files has benefits:

 - the sync between debug versus not debug is mechanical

 - it allows easier maintainance by improving readability
   and writability (ex: macros TARGET or UNIT_NAME_BASE)

Change-Id: Ic0427bedf4f8a5b174318562336603077f174fa5
Signed-off-by: José Bollo <jose.bollo@iot.bzh>

5 files changed, 362 insertions, 0 deletions

diff --git a/conf/generate-unit-conf/Makefile b/conf/generate-unit-conf/Makefile
new file mode 100644
index 0000000..5f5346b
--- /dev/null
+++ b/conf/generate-unit-conf/Makefile
@@ -0,0 +1,25 @@
+.PHONY: all
+
+MAIN = afm-unit
+
+FILES = $(MAIN) binder.inc provided.inc service.inc Makefile
+
+DIR = ..
+
+#AFM_CONFIG_DIR ?= /etc/afm
+AFM_CONFIG_DIR ?= "@afm_confdir@"
+
+C = -DAFM_CONFIG_DIR=$(AFM_CONFIG_DIR)
+
+D = -DAGL_DEVEL
+
+all: $(DIR)/afm-unit.conf.in $(DIR)/afm-unit-debug.conf.in
+
+$(DIR)/afm-unit.conf.in: $(FILES)
+	@echo generating $@
+	@m4 $C $< | sed '/^[ \t]*\\*[ \t]*$$/d' > $@
+
+$(DIR)/afm-unit-debug.conf.in: $(FILES)
+	@echo generating $@
+	@m4 $C $D $< | sed '/^[ \t]*\\*[ \t]*$$/d' > $@
+
diff --git a/conf/generate-unit-conf/afm-unit b/conf/generate-unit-conf/afm-unit
new file mode 100644
index 0000000..e3abf19
--- /dev/null
+++ b/conf/generate-unit-conf/afm-unit
@@ -0,0 +1,142 @@
+divert(-1)
+-----------------------------------------------------------------------
+-- Set the comment character of m4 to ; instead of #
+-- This is needed for substitution within lines starting with #
+changecom( ';')
+
+-----------------------------------------------------------------------
+-- 
+define( `X_EMITS', 1)
+define( `X_DIVERTS', `divert(eval(-!X_EMITS()))')
+define( `X_PUSH_DIVERTS', `pushdef(`X_EMITS', eval(X_EMITS() && $1))X_DIVERTS()')
+
+define( `X_IF', `pushdef(`X_COND', $1)X_PUSH_DIVERTS($1)')
+define( `X_ELSE', `popdef(`X_EMITS')X_PUSH_DIVERTS(eval(!X_COND))')
+define( `X_ELIF', `X_ELSE()X_IF($1)')
+define( `X_ENDIF', `popdef(`X_EMITS')popdef(`X_COND')X_DIVERTS()')
+
+define( `IF', `pushdef(`ELSE',`X_ELSE()')pushdef(`ELIF',`X_ELIF($1)')pushdef(`ENDIF',`X_ENDIF()popdef(`ELSE',`ELIF',`ENDIF')')X_IF($1)')
+
+-----------------------------------------------------------------------
+-- 
+define( `MUSTACH_ON', `ifelse(`$2',,,`{{#$1}}`$2'{{/$1}}')ifelse(`$3',,,`{{^$1}}`$3'{{/$1}}')')
+define( `MUSTACH_IF', `{{#$1}}pushdef(`ELSE',`{{/$1}}{{^$1}}')pushdef(`ENDIF',`{{/$1}}popdef(`ELSE',`ENDIF')')')
+define( `MUSTACH_IF_NOT', `{{^$1}}pushdef(`ELSE',`{{/$1}}{{#$1}}')pushdef(`ENDIF',`{{/$1}}popdef(`ELSE',`ENDIF')')')
+
+-----------------------------------------------------------------------
+-- 
+define( `PERM', `urn:AGL:permission:$1')
+define( `REQPERM', `required-permission.PERM($1)')
+
+define( `ON_PERM', `MUSTACH_ON(REQPERM($1),$2,$3)')
+define( `IF_PERM', `MUSTACH_IF(REQPERM($1))')
+define( `IF_NOT_PERM', `MUSTACH_IF_NOT(REQPERM($1))')
+
+define( `ON_CONTENT', `MUSTACH_ON(content.type=$1,$2,$3)')
+define( `IF_CONTENT', `MUSTACH_IF(content.type=$1)')
+define( `IF_NOT_CONTENT', `MUSTACH_IF_NOT(content.type=$1)')
+
+define( `ON_VALUE', `MUSTACH_ON(value=$1,$2,$3)')
+define( `IF_VALUE', `MUSTACH_IF(value=$1)')
+define( `IF_NOT_VALUE', `MUSTACH_IF_NOT(value=$1)')
+
+-----------------------------------------------------------------------
+-- 
+define( `TARGET', `{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}')
+define( `UNIT_NAME_BASE', `afm-ON_PERM(`:public:hidden', `service', `appli')-{{:id}}--{{:ver}}--{{:#target}}')
+define( `UNIT_NAME_SERVICE', `UNIT_NAME_BASE%i.service')
+define( `UNIT_NAME_SOCKET_FOR', `afm-api-ws-$1@%i.socket')
+
+-----------------------------------------------------------------------
+-- 
+define( `ON_AGL_DEVEL', `ifdef(`AGL_DEVEL', $1, $2)')
+define( `IF_AGL_DEVEL', `IF(ON_AGL_DEVEL(1,0))')
+
+divert(0)dnl
+;---------------------------------------------------------------------------------
+; File:
+;
+;    afm-unit.conf
+;
+; Mode:
+;
+;    ON_AGL_DEVEL(DEVEL, RELEASE)
+;
+; Role:
+;
+;    Configure how installation of widget produces unit files for systemd
+;
+; Processing and format:
+;
+;    1. File load
+;
+;           Lines beginning with ; are firstly removed
+;
+;    2. File instantiation
+;
+;           Mustache (extended) substitutions are applied using JSON
+;           data deduced from config.xml file of the widget.
+;
+;    3. Extraction of units
+;
+;           Extract produced units, pack it (remove empty lines and directives)
+;
+; Directives:
+;
+;    Any directive occupy one whole line starting with %
+;
+;     - %nl
+;
+;             produce an empty line at the end
+;
+;     - %begin systemd-unit
+;     - %end systemd-unit
+;
+;             delimit the produced unit
+;
+;     - %systemd-unit user
+;     - %systemd-unit system
+;
+;             tells the kind of unit (user/system)
+;
+;     - %systemd-unit service NAME
+;     - %systemd-unit socket NAME
+;
+;             gives the name and type of the unit
+;
+;     - %systemd-unit wanted-by NAME
+;
+;             tells to install a link to unit in the wants of NAME
+;
+; Setting variables:
+;
+;    AFM uses the feature of systemd that completely ignores options prefixed
+;    with X-
+;
+;    Consequently, options starting with X-AFM- are recorded as public data
+;    about the application and options starting starting with X-AFM-- are
+;    recorded as private data.
+;
+;    Examples:
+;
+;        X-AFM-description={{description}}
+;
+;              Records the description of the unit in the field "description"
+;              of both the public and private object describing the unit.
+;
+;        X-AFM--wgtdir={{:#metadata.install-dir}}
+;
+;              Records the installation directory path in the field "wgtdir"
+;              of the private object only.
+;
+;---------------------------------------------------------------------------------
+{{#targets}}
+
+include(service.inc)
+
+include(provided.inc)
+
+{{/targets}}
+;---------------------------------------------------------------------------------
+; End of file afm-unit.conf mode ON_AGL_DEVEL(DEVEL, RELEASE)
+;---------------------------------------------------------------------------------
diff --git a/conf/generate-unit-conf/binder.inc b/conf/generate-unit-conf/binder.inc
new file mode 100644
index 0000000..a99467a
--- /dev/null
+++ b/conf/generate-unit-conf/binder.inc
@@ -0,0 +1,44 @@
+
+IF_AGL_DEVEL
+X-AFM-http-port={{:#metadata.http-port}}
+ELSE
+IF_NOT_CONTENT(application/vnd.agl.service)
+X-AFM--http-port={{:#metadata.http-port}}
+ENDIF
+ENDIF
+
+ExecStart=/usr/bin/afb-daemon \
+	--name afbd-TARGET \
+	--rootdir={{:#metadata.install-dir}} \
+	--workdir={{&#metadata.app-data-dir}}/{{id}} \
+IF_AGL_DEVEL \
+	--verbose \
+	--verbose \
+	--monitoring \
+	--port={{:#metadata.http-port}} \
+	--token=HELLO \
+	--roothttp=ON_CONTENT(application/vnd.agl.service, ., ON_PERM(:public:no-htdocs, ., htdocs)) \
+ELSE \
+	IF_CONTENT(application/vnd.agl.service) \
+		--no-httpd \
+	ELSE \
+		--port={{:#metadata.http-port}} \
+		--random-token \
+		--roothttp=ON_PERM(:public:no-htdocs, ., htdocs) \
+	ENDIF \
+ENDIF \
+	ON_PERM(:public:applications:read, --alias=/icons:{{:#metadata.icons-dir}}) \
+	{{#required-api}} \
+		ON_VALUE(auto|ws,	--ws-client=unix:%t/apis/ws/{{name}}) \
+		ON_VALUE(dbus,		--dbus-client={{name}}) \
+		ON_VALUE(link,		--binding=%t/apis/lib/{{name}}) \
+		ON_VALUE(cloud,		--cloud-client={{name}}) \
+		ON_VALUE(local,		--binding={{:#metadata.install-dir}}/{{name}}) \
+	{{/required-api}} \
+	{{#provided-api}} \
+		ON_VALUE(auto|ws,	--ws-server=sd:{{name}}) \
+		ON_VALUE(dbus,		--dbus-server={{name}}) \
+	{{/provided-api}} \
+	ON_CONTENT(text/html,			--exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t) \
+	ON_CONTENT(application/vnd.agl.native,	--exec {{:#metadata.install-dir}}/{{content.src}} @p @t)
+
diff --git a/conf/generate-unit-conf/provided.inc b/conf/generate-unit-conf/provided.inc
new file mode 100644
index 0000000..d42ba77
--- /dev/null
+++ b/conf/generate-unit-conf/provided.inc
@@ -0,0 +1,32 @@
+;---------------------------------------------------------------------------------
+;----        P R O V I D E D   A P I S                                        ----
+;---------------------------------------------------------------------------------
+
+{{#provided-api}}
+{{#value=ws|auto}}
+
+%begin systemd-unit
+
+# auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
+
+%systemd-unit system
+%systemd-unit socket afm-api-ws-{{name}}@
+
+[Socket]
+SmackLabel=*
+ListenStream=%t/apis/ws/{{name}}
+FileDescriptorName={{name}}
+
+Service=UNIT_NAME_SERVICE
+
+%nl
+[Install]
+WantedBy=sockets.target
+%systemd-unit wanted-by sockets.target
+
+%end systemd-unit
+
+{{/value=ws|auto}}
+{{/provided-api}}
+
+
diff --git a/conf/generate-unit-conf/service.inc b/conf/generate-unit-conf/service.inc
new file mode 100644
index 0000000..040eb16
--- /dev/null
+++ b/conf/generate-unit-conf/service.inc
@@ -0,0 +1,119 @@
+;---------------------------------------------------------------------------------
+;----         M A I N    P A R T    O F   T H E   S E R V I C E               ----
+;---------------------------------------------------------------------------------
+%begin systemd-unit
+
+# auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
+%nl
+
+[Unit]
+Description={{description}}
+X-AFM-description={{description}}
+X-AFM-name={{name.content}}
+X-AFM-shortname={{name.short}}
+#***************
+# use X-AFM-id={{:id}}--{{:ver}}--{{:#target}}
+# instead of:
+X-AFM-id=TARGET
+# when home screen will use real ids
+#**************
+X-AFM-version={{:version}}
+X-AFM-author={{author.content}}
+X-AFM-author-email={{author.email}}
+X-AFM-width={{width}}
+X-AFM-height={{height}}
+{{#icon}}
+X-AFM-icon={{:#metadata.install-dir}}/{{:src}}
+{{/icon}}
+X-AFM--ID={{:id}}
+X-AFM--target-name={{:#target}}
+X-AFM--content={{content.src}}
+X-AFM--type={{content.type}}
+X-AFM--wgtdir={{:#metadata.install-dir}}
+X-AFM--workdir={{&#metadata.app-data-dir}}/{{:id}}
+%nl
+
+Wants=sockets.target
+
+# Adds check to smack
+ConditionSecurity=smack
+%nl
+
+# Automatic bound to required api
+{{#required-api}}
+{{#value=auto|ws}}
+BindsTo=UNIT_NAME_SOCKET_FOR({{name}})
+After=UNIT_NAME_SOCKET_FOR({{name}})
+{{/value=auto|ws}}
+{{/required-api}}
+%nl
+
+[Service]
+EnvironmentFile=-AFM_CONFIG_DIR/unit.env.d/*
+SmackProcessLabel=User::App::{{:id}}
+SuccessExitStatus=0 SIGKILL
+
+#PAMName=su
+User=%i
+Slice=user-%i.slice
+
+CapabilityBoundingSet=
+AmbientCapabilities=
+
+ON_PERM(:platform:no-oom,   OOMScoreAdjust=-500)
+ON_PERM(:partner:real-time, IOSchedulingClass=realtime)
+ON_PERM(:public:display,    SupplementaryGroups=display)
+ON_PERM(:public:syscall:clock, , SystemCallFilter=~@clock)
+%nl
+
+WorkingDirectory=-{{&#metadata.app-data-dir}}/{{:id}}
+ExecStartPre=/bin/mkdir -p {{&#metadata.app-data-dir}}/{{:id}}
+Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
+Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}
+Environment=XDG_DATA_HOME={{&#metadata.app-data-dir}}/{{:id}}
+Environment=XDG_CONFIG_HOME={{&#metadata.app-data-dir}}/{{:id}}
+Environment=XDG_CACHE_HOME={{&#metadata.app-data-dir}}/{{:id}}
+Environment=XDG_RUNTIME_DIR=/run/user/%i
+Environment=DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/%i/bus
+Environment=LD_LIBRARY_PATH=$ORIGIN/lib
+
+IF_AGL_DEVEL
+; Needed to enable debug
+Environment=AFM_ID=TARGET
+EnvironmentFile=-/var/run/afm-debug/TARGET.env
+ENDIF
+
+%systemd-unit system
+%systemd-unit service UNIT_NAME_BASE
+
+SyslogIdentifier=afbd-TARGET
+StandardInput=null
+StandardOutput=journal
+StandardError=journal
+
+;---------------------------------------------------------------------------------
+;----   text/html  application/vnd.agl.native  application/vnd.agl.service    ----
+;---------------------------------------------------------------------------------
+{{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
+include(binder.inc)
+{{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
+
+;---------------------------------------------------------------------------------
+;----                 application/x-executable                                ----
+;---------------------------------------------------------------------------------
+{{#content.type=application/x-executable}}
+ExecStart={{:#metadata.install-dir}}/{{content.src}}
+{{/content.type=application/x-executable}}
+
+IF_PERM(:system:run-by-default)
+;---------------------------------------------------------------------------------
+; auto start
+;---------------------------------------------------------------------------------
+[Install]
+WantedBy=default.target
+%systemd-unit wanted-by default.target
+ENDIF
+
+%end systemd-unit
+
+