Provide unit in config.xml and documentation
[src/app-framework-main.git] / conf / afm-unit.conf
index 0853d11..82113ef 100644 (file)
@@ -24,7 +24,7 @@
 ;
 ; Directives:
 ;
-;    All directive occopy one whole line starting with %
+;    Any directive occupy one whole line starting with %
 ;
 ;     - %nl
 ;
 ;
 ;             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 descritpion 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}}
+
+;---------------------------------------------------------------------------------
+;----        P R O V I D E D   U N I T S                                      ----
+;---------------------------------------------------------------------------------
 %begin systemd-unit
 
-# auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}}
+# auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
 %nl
 
-[unit]
+[Unit]
 Description={{description}}
-X-AGL-Name={{name.content}}
-X-AGL-Name-Short={{name.short}}
-X-AGL-Id={{id}}
-X-AGL-Idaver={{idaver}}
-X-AGL-Target-Name={{:#target}}
-X-AGL-Author={{author.content}}
-X-AGL-Author-email={{author.email}}
-X-AGL-HTTP-port={{:#metadata.http-port}}
+X-AFM-description={{description}}
+X-AFM-name={{name.content}}
+X-AFM-shortname={{name.short}}
+X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+X-AFM-version={{version}}
+X-AFM-author={{author.content}}
+X-AFM-author-email={{author.email}}
+X-AFM-width={{width}}
+X-AFM-height={{height}}
+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
 
 # Adds check to smack
@@ -77,6 +113,7 @@ After=afm-api-{{name}}
 
 [Service]
 SmackProcessLabel=User::App::{{id}}
+SuccessExitStatus=0 SIGKILL
 
 {{#required-permission}}
   {{#urn:AGL:permission::platform:no-oom}}      OOMScoreAdjust=-500             {{/urn:AGL:permission::platform:no-oom}}
@@ -84,24 +121,38 @@ SmackProcessLabel=User::App::{{id}}
   {{^urn:AGL:permission::partner:real-time}}    RestrictRealtime=on             {{/urn:AGL:permission::partner:real-time}}
   {{#urn:AGL:permission::public:display}}       SupplementaryGroups=display     {{/urn:AGL:permission::public:display}}
   {{^urn:AGL:permission::public:syscall:clock}} SystemCallFilter=~@clock        {{/urn:AGL:permission::public:syscall:clock}}
-  {{^urn:AGL:permission::public:internet}}      RestrictAddressFamilies=AF_UNIX {{/urn:AGL:permission::public:internet}}
 {{/required-permission}}
 %nl
 
-WorkingDirectory={{&#metadata.app-data-dir}}
-SuccessExitStatus=0 SIGKILL
-
-;---------------------------------------------------------------------------------
-{{#content.type=text/html}}
+WorkingDirectory=-{{&#metadata.app-data-dir}}/{{id}}
+ExecStartPre=/bin/mkdir -p {{&#metadata.app-data-dir}}/{{id}}
+Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 
 %systemd-unit user
-
+{{#required-permission.urn:AGL:permission::public:hidden}}\
+%systemd-unit service afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+{{/required-permission.urn:AGL:permission::public:hidden}}\
+{{^required-permission.urn:AGL:permission::public:hidden}}\
 %systemd-unit service afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+{{/required-permission.urn:AGL:permission::public:hidden}}\
 
-ExecStart=/usr/bin/afb-daemon --port={{:#metadata.http-port}} --random-token \
+;---------------------------------------------------------------------------------
+;----                 text/html                                               ----
+;---------------------------------------------------------------------------------
+{{#content.type=text/html}}
+
+X-AFM--http-port={{:#metadata.http-port}}
+ExecStart=/usr/bin/afb-daemon \
+       --port={{:#metadata.http-port}} \
+       --random-token \
        --rootdir={{:#metadata.install-dir}} \
        --workdir={{&#metadata.app-data-dir}}/{{id}} \
-       --roothttp=htdocs \
+       {{#required-permission.urn:AGL:permission::public:no-htdocs}}\
+               --roothttp=. \
+       {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
+       {{^required-permission.urn:AGL:permission::public:no-htdocs}}\
+               --roothttp=htdocs \
+       {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
        {{#required-permission.urn:AGL:permission::public:applications:read}}\
                --alias=/icons:{{:#metadata.icons-dir}} \
        {{/required-permission.urn:AGL:permission::public:applications:read}}\
@@ -121,54 +172,178 @@ ExecStart=/usr/bin/afb-daemon --port={{:#metadata.http-port}} --random-token \
                {{#value=cloud}}\
                        --cloud-client={{name}} \
                {{/value=cloud}}\
+               {{#value=local}}\
+                       --binding={{:#metadata.install-dir}}/{{name}} \
+               {{/value=local}}\
        {{/required-api}}\
+       {{#provided-api}}\
+               {{#value=auto}}\
+                       {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
+                               --ws-server=sd:{{name}} \
+                       {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
+                       {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
+                               --dbus-server={{name}} \
+                       {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
+               {{/value=auto}}\
+               {{#value=ws}}\
+                       --ws-server=sd:{{name}} \
+               {{/value=ws}}\
+               {{#value=dbus}}\
+                       --dbus-server={{name}} \
+               {{/value=dbus}}\
+       {{/provided-api}}\
        --exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t
 
 {{/content.type=text/html}}
 
 ;---------------------------------------------------------------------------------
-{{#content.type=application/vnd.agl.service}}
+;----                 application/x-executable                                ----
+;---------------------------------------------------------------------------------
+{{#content.type=application/x-executable}}
 
-%systemd-unit user
-%systemd-unit service afm-api-{{:#target}}
+Environment=LD_LIBRARY_PATH=$ORIGIN/$LIB
+
+ExecStart={{:#metadata.install-dir}}/{{content.src}}
+
+{{/content.type=application/x-executable}}
+
+;---------------------------------------------------------------------------------
+;----                 application/vnd.agl.service                             ----
+;---------------------------------------------------------------------------------
+{{#content.type=application/vnd.agl.service}}
 
 ExecStart=/usr/bin/afb-daemon \
        --rootdir={{:#metadata.install-dir}} \
        --workdir={{&#metadata.install-dir}}/{{id}} \
-       {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
-               --ws-server=unix:%t/bindings/{{:#target}} \
-       {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
-       {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
-               --dbus-server={{:#target}} \
-       {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
-       --no-httpd 
+       {{#required-api}}\
+               {{#value=auto}}\
+                       --ws-client=unix:%t/apis/ws/{{name}} \
+               {{/value=auto}}\
+               {{#value=ws}}\
+                       --ws-client=unix:%t/apis/ws/{{name}} \
+               {{/value=ws}}\
+               {{#value=dbus}}\
+                       --dbus-client={{name}} \
+               {{/value=dbus}}\
+               {{#value=link}}\
+                       --binding=%t/apis/lib/{{name}} \
+               {{/value=link}}\
+               {{#value=cloud}}\
+                       --cloud-client={{name}} \
+               {{/value=cloud}}\
+               {{#value=local}}\
+                       --binding={{:#metadata.install-dir}}/{{name}} \
+               {{/value=local}}\
+       {{/required-api}}\
+       {{#provided-api}}\
+               {{#value=auto}}\
+                       {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
+                               --ws-server=sd:{{name}} \
+                       {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
+                       {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
+                               --dbus-server={{name}} \
+                       {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
+               {{/value=auto}}\
+               {{#value=ws}}\
+                       --ws-server=sd:{{name}} \
+               {{/value=ws}}\
+               {{#value=dbus}}\
+                       --dbus-server={{name}} \
+               {{/value=dbus}}\
+       {{/provided-api}}\
+       --no-httpd
+
+
+{{/content.type=application/vnd.agl.service}}
 
-{{^required-permission.urn:AGL:permission::partner:service:no-ws}}
+
+;---------------------------------------------------------------------------------
+; auto start
+;---------------------------------------------------------------------------------
+{{#required-permission.urn:AGL:permission::system:run-by-default}}
+{{^provided-api}}
+%nl
+[Install]
+WantedBy=default.target
+%systemd-unit wanted-by default.target
+{{/provided-api}}
+{{/required-permission.urn:AGL:permission::system:run-by-default}}
 
 %end systemd-unit
+
+
+;---------------------------------------------------------------------------------
+;----        P R O V I D E D   A P I S                                        ----
+;---------------------------------------------------------------------------------
+
+{{#provided-api}}
+{{#value=ws}}
+
 %begin systemd-unit
 
-# auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}}
+# auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
 #
 %systemd-unit user
-%systemd-unit socket afm-api-{{:#target}}
-
+%systemd-unit socket afm-socket-{{name}}
 
-[socket]
+[Socket]
 SmackLabel=*
-ListenStream=%t/bindings/{{:#target}}
+ListenStream=%t/bindings/{{name}}
+FileDescriptorName={{name}}
 
-{{/required-permission.urn:AGL:permission::partner:service:no-ws}}
+{{#required-permission.urn:AGL:permission::public:hidden}}\
+Service=afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+{{/required-permission.urn:AGL:permission::public:hidden}}\
+{{^required-permission.urn:AGL:permission::public:hidden}}\
+Service=afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+{{/required-permission.urn:AGL:permission::public:hidden}}\
 
-{{/content.type=application/vnd.agl.service}}
+;---------------------------------------------------------------------------------
+{{#required-permission.urn:AGL:permission::system:run-by-default}}
+%nl
+[Install]
+WantedBy=default.target
+%systemd-unit wanted-by default.target
+{{/required-permission.urn:AGL:permission::system:run-by-default}}
+;---------------------------------------------------------------------------------
+
+%end systemd-unit
+
+{{/value=ws}}
+{{#value=auto}}
+
+%begin systemd-unit
+
+# auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
+#
+%systemd-unit user
+%systemd-unit socket afm-socket-{{name}}
+
+[Socket]
+SmackLabel=*
+ListenStream=%t/bindings/{{name}}
+FileDescriptorName={{name}}
+
+{{#required-permission.urn:AGL:permission::public:hidden}}\
+Service=afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+{{/required-permission.urn:AGL:permission::public:hidden}}\
+{{^required-permission.urn:AGL:permission::public:hidden}}\
+Service=afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
+{{/required-permission.urn:AGL:permission::public:hidden}}\
 
 ;---------------------------------------------------------------------------------
 {{#required-permission.urn:AGL:permission::system:run-by-default}}
-[install]
+%nl
+[Install]
 WantedBy=default.target
+%systemd-unit wanted-by default.target
 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 ;---------------------------------------------------------------------------------
+
 %end systemd-unit
-{{/targets}}
 
+{{/value=auto}}
+{{/provided-api}}
+
+{{/targets}}