conf/unit/afm-unit.conf.in

   1 ;---------------------------------------------------------------------------------
   2 ; File:
   3 ;
   4 ;    afm-unit.conf
   5 ;
   6 ; Mode:
   7 ;
   8 ;    RELEASE
   9 ;
  10 ; Role:
  11 ;
  12 ;    Configure how installation of widget produces unit files for systemd
  13 ;
  14 ; Processing and format:
  15 ;
  16 ;    1. File load
  17 ;
  18 ;           Lines beginning with ; are firstly removed
  19 ;
  20 ;    2. File instantiation
  21 ;
  22 ;           Mustache (extended) substitutions are applied using JSON
  23 ;           data deduced from config.xml file of the widget.
  24 ;
  25 ;    3. Extraction of units
  26 ;
  27 ;           Extract produced units, pack it (remove empty lines and directives)
  28 ;
  29 ; Directives:
  30 ;
  31 ;    Any directive occupy one whole line starting with %
  32 ;
  33 ;     - %nl
  34 ;
  35 ;             produce an empty line at the end
  36 ;
  37 ;     - %begin systemd-unit
  38 ;     - %end systemd-unit
  39 ;
  40 ;             delimit the produced unit
  41 ;
  42 ;     - %systemd-unit user
  43 ;     - %systemd-unit system
  44 ;
  45 ;             tells the kind of unit (user/system)
  46 ;
  47 ;     - %systemd-unit service NAME
  48 ;     - %systemd-unit socket NAME
  49 ;
  50 ;             gives the name and type of the unit
  51 ;
  52 ;     - %systemd-unit wanted-by NAME
  53 ;
  54 ;             tells to install a link to unit in the wants of NAME
  55 ;
  56 ; Setting variables:
  57 ;
  58 ;    AFM uses the feature of systemd that completely ignores options prefixed
  59 ;    with X-
  60 ;
  61 ;    Consequently, options starting with X-AFM- are recorded as public data
  62 ;    about the application and options starting starting with X-AFM-- are
  63 ;    recorded as private data.
  64 ;
  65 ;    Examples:
  66 ;
  67 ;        X-AFM-description={{description}}
  68 ;
  69 ;              Records the description of the unit in the field "description"
  70 ;              of both the public and private object describing the unit.
  71 ;
  72 ;        X-AFM--wgtdir={{:#metadata.install-dir}}
  73 ;
  74 ;              Records the installation directory path in the field "wgtdir"
  75 ;              of the private object only.
  76 ;
  77 ;---------------------------------------------------------------------------------
  78 {{#targets}}
  79 ;---------------------------------------------------------------------------------
  80 ;----         M A I N    P A R T    O F   T H E   S E R V I C E               ----
  81 ;---------------------------------------------------------------------------------
  82 %begin systemd-unit
  83 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
  84 %nl
  85 %systemd-unit system
  86 %systemd-unit service afm-{{#required-permission.urn:AGL:permission::public:hidden}}service{{/required-permission.urn:AGL:permission::public:hidden}}{{^required-permission.urn:AGL:permission::public:hidden}}appli{{/required-permission.urn:AGL:permission::public:hidden}}-{{:id}}--{{:ver}}--{{:#target}}@
  87 [Unit]
  88 Description={{description}}
  89 X-AFM-description={{description}}
  90 X-AFM-name={{name.content}}
  91 X-AFM-shortname={{name.short}}
  92 X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
  93 X-AFM-version={{:version}}
  94 X-AFM-author={{author.content}}
  95 X-AFM-author-email={{author.email}}
  96 X-AFM-width={{width}}
  97 X-AFM-height={{height}}
  98 {{#icon}}
  99 X-AFM-icon={{:#metadata.install-dir}}/{{:src}}
 100 {{/icon}}
 101 X-AFM--ID={{:id}}
 102 X-AFM--target-name={{:#target}}
 103 X-AFM--content={{content.src}}
 104 X-AFM--type={{content.type}}
 105 X-AFM--wgtdir={{:#metadata.install-dir}}
 106 X-AFM--workdir=/home/%i/app-data/{{:id}}
 107 %nl
 108 Requires=afm-user-session@%i.target
 109 After=user@%i.service
 110 After=Network.target
 111 # Adds check to smack
 112 ConditionSecurity=smack
 113 %nl
 114 # Automatic bound to required api
 115 {{#required-binding}}
 116 {{#value=extern}}
 117 BindsTo=afm-link-{{name}}@%i.service
 118 After=afm-link-{{name}}@%i.service
 119 {{/value=extern}}
 120 {{/required-binding}}
 121 {{#required-api}}
 122 {{#value=auto|ws}}
 123 BindsTo=afm-api-{{name}}@%i.service
 124 After=afm-api-{{name}}@%i.service
 125 {{/value=auto|ws}}
 126 {{/required-api}}
 127 {{#provided-api}}
 128 {{#value=ws|auto}}
 129 Requires=afm-api-{{name}}@%i.socket
 130 After=afm-api-{{name}}@%i.socket
 131 {{/value=ws|auto}}
 132 {{/provided-api}}
 133 %nl
 134 [Service]
 135 EnvironmentFile=-@afm_confdir@/unit.env.d/*
 136 SmackProcessLabel=User::App::{{:id}}
 137 SuccessExitStatus=0 SIGKILL
 138 User=%i
 139 Slice=user-%i.slice
 140 #CapabilityBoundingSet=
 141 #AmbientCapabilities=
 142 {{#required-permission.urn:AGL:permission::platform:no-oom}}OOMScoreAdjust=-500{{/required-permission.urn:AGL:permission::platform:no-oom}}
 143 {{#required-permission.urn:AGL:permission::partner:real-time}}IOSchedulingClass=realtime{{/required-permission.urn:AGL:permission::partner:real-time}}
 144 {{#required-permission.urn:AGL:permission::public:display}}SupplementaryGroups=display{{/required-permission.urn:AGL:permission::public:display}}
 145 {{^required-permission.urn:AGL:permission::public:syscall:clock}}SystemCallFilter=~@clock{{/required-permission.urn:AGL:permission::public:syscall:clock}}
 146 %nl
 147 WorkingDirectory=-/home/%i/app-data/{{:id}}
 148 ExecStartPre=/bin/mkdir -p /home/%i/app-data/{{:id}}
 149 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 150 Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}/bin
 151 Environment=LD_LIBRARY_PATH={{:#metadata.install-dir}}/lib
 152 Environment=XDG_DATA_HOME=/home/%i/app-data/{{:id}}
 153 Environment=XDG_CONFIG_HOME=/home/%i/app-data/{{:id}}
 154 Environment=XDG_CACHE_HOME=/home/%i/app-data/{{:id}}
 155 Environment=XDG_RUNTIME_DIR=@afm_users_rundir@/%i
 156 Environment=DBUS_SESSION_BUS_ADDRESS=unix:path=@afm_users_rundir@/%i/bus
 157 SyslogIdentifier=afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 158 StandardInput=null
 159 StandardOutput=journal
 160 StandardError=journal
 161 ;---------------------------------------------------------------------------------
 162 ;----   text/html  application/vnd.agl.native  application/vnd.agl.service    ----
 163 ;---------------------------------------------------------------------------------
 164 {{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 165 {{^content.type=application/vnd.agl.service}}
 166 X-AFM--http-port={{:#metadata.http-port}}
 167 {{/content.type=application/vnd.agl.service}}
 168 Type=notify
 169 ExecStart=/usr/bin/afb-daemon \
 170         --name afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} \
 171         --rootdir={{:#metadata.install-dir}} \
 172         --workdir=/home/%i/app-data/{{id}} \
 173         {{#content.type=application/vnd.agl.service}} \
 174                 --no-httpd \
 175         {{/content.type=application/vnd.agl.service}}{{^content.type=application/vnd.agl.service}} \
 176                 --port={{:#metadata.http-port}} \
 177                 --random-token \
 178                 --roothttp={{#required-permission.urn:AGL:permission::public:no-htdocs}}.{{/required-permission.urn:AGL:permission::public:no-htdocs}}{{^required-permission.urn:AGL:permission::public:no-htdocs}}htdocs{{/required-permission.urn:AGL:permission::public:no-htdocs}} \
 179         {{/content.type=application/vnd.agl.service}} \
 180         {{#required-permission.urn:AGL:permission::public:applications:read}}--alias=/icons:{{:#metadata.icons-dir}}{{/required-permission.urn:AGL:permission::public:applications:read}} \
 181         {{#required-api}} \
 182                 {{#value=auto|ws}}--ws-client=unix:@afm_users_rundir@/%i/apis/ws/{{name}}{{/value=auto|ws}} \
 183                 {{#value=dbus}}--dbus-client={{name}}{{/value=dbus}} \
 184                 {{#value=cloud}}--cloud-client={{name}}{{/value=cloud}} \
 185                 {{#value=local}}--binding={{:#metadata.install-dir}}/{{name}}{{/value=local}} \
 186                 {{#value=tcp}}--ws-client=tcp:{{name}}{{/value=tcp}} \
 187         {{/required-api}} \
 188         {{#required-binding}} \
 189                 {{#value=local}}--binding={{:#metadata.install-dir}}/{{name}}{{/value=local}} \
 190                 {{#value=extern}}--binding=@afm_users_rundir@/%i/apis/link/{{name}}{{/value=extern}} \
 191         {{/required-binding}} \
 192         {{#provided-api}} \
 193                 {{#value=auto|ws}}--ws-server=sd:{{name}}{{/value=auto|ws}} \
 194                 {{#value=dbus}}--dbus-server={{name}}{{/value=dbus}} \
 195                 {{#value=tcp}}--ws-server=tcp:{{name}}{{/value=tcp}} \
 196         {{/provided-api}} \
 197         {{#content.type=text/html}}--exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t{{/content.type=text/html}} \
 198         {{#content.type=application/vnd.agl.native}}--exec {{:#metadata.install-dir}}/{{content.src}} @p @t{{/content.type=application/vnd.agl.native}}
 199 {{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 200 ;---------------------------------------------------------------------------------
 201 ;----                 application/x-executable                                ----
 202 ;---------------------------------------------------------------------------------
 203 {{#content.type=application/x-executable}}
 204 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 205 {{/content.type=application/x-executable}}
 206 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 207 ;---------------------------------------------------------------------------------
 208 ; auto start
 209 ;---------------------------------------------------------------------------------
 210 [Install]
 211 WantedBy=afm-user-session@.target
 212 %systemd-unit wanted-by afm-user-session@.target
 213 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 214 %end systemd-unit
 215 ;-------------------------------------------------------------------------------
 216 ;----        P R O V I D E D   A P I S                                      ----
 217 ;-------------------------------------------------------------------------------
 218 {{#provided-api}}
 219 {{#value=ws|auto}}
 220 ;-------------------------------------------------------------------------------
 221 ;----        T H E   S E R V I C E   O F   T H E   A P I                    ----
 222 ;-------------------------------------------------------------------------------
 223 %begin systemd-unit
 224 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 225 %systemd-unit system
 226 %systemd-unit service afm-api-{{name}}@
 227 [Unit]
 228 Description=Provides api {{name}} for user %i
 229 X-AFM-API-TYPE={{value}}
 230 Requires=afm-user-setup@%i.service
 231 After=afm-user-setup@%i.service
 232 {{#value=ws|auto}}
 233 Requires=afm-api-{{name}}@%i.socket
 234 After=afm-api-{{name}}@%i.socket
 235 {{/value=ws|auto}}
 236 [Service]
 237 Type=oneshot
 238 RemainAfterExit=yes
 239 {{#value=ws|auto}}
 240 ExecStart=/bin/true
 241 {{/value=ws|auto}}
 242 %end systemd-unit
 243 ;-------------------------------------------------------------------------------
 244 ;----        T H E   S O C K E T   O F   T H E   A P I                      ----
 245 ;-------------------------------------------------------------------------------
 246 %begin systemd-unit
 247 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 248 %systemd-unit system
 249 %systemd-unit socket afm-api-{{name}}@
 250 [Unit]
 251 Description=Provides websocket api {{name}} for user %i
 252 Requires=afm-user-setup@%i.service
 253 After=afm-user-setup@%i.service
 254 DefaultDependencies=no
 255 [Socket]
 256 SmackLabel=*
 257 SmackLabelIPIn=System
 258 SmackLabelIPOut=System
 259 ListenStream=@afm_users_rundir@/%i/apis/ws/{{name}}
 260 FileDescriptorName={{name}}
 261 Service=afm-{{#required-permission.urn:AGL:permission::public:hidden}}service{{/required-permission.urn:AGL:permission::public:hidden}}{{^required-permission.urn:AGL:permission::public:hidden}}appli{{/required-permission.urn:AGL:permission::public:hidden}}-{{:id}}--{{:ver}}--{{:#target}}@%i.service
 262 %end systemd-unit
 263 {{/value=ws|auto}}
 264 {{/provided-api}}
 265 ;-------------------------------------------------------------------------------
 266 ;----        P R O V I D E D   B I N D I N G                                ----
 267 ;-------------------------------------------------------------------------------
 268 {{#provided-binding}}
 269 ;-------------------------------------------------------------------------------
 270 ;----        T H E   S E R V I C E   O F   T H E   B I N D I N G            ----
 271 ;-------------------------------------------------------------------------------
 272 %begin systemd-unit
 273 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 274 %systemd-unit system
 275 %systemd-unit service afm-link-{{name}}@
 276 [Unit]
 277 Description=Provides binding {{name}} for user %i
 278 Requires=afm-user-setup@%i.service
 279 After=afm-user-setup@%i.service
 280 [Service]
 281 Type=oneshot
 282 RemainAfterExit=yes
 283 ExecStart=/bin/ln -sf {{:#metadata.install-dir}}/{{value}} @afm_users_rundir@/%i/apis/link/{{name}}
 284 %end systemd-unit
 285 {{/provided-binding}}
 286 {{/targets}}
 287 ;---------------------------------------------------------------------------------
 288 ; End of file afm-unit.conf mode RELEASE
 289 ;---------------------------------------------------------------------------------