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 # Adds check to smack
 111 ConditionSecurity=smack
 112 %nl
 113 # Automatic bound to required api
 114 {{#required-binding}}
 115 {{#value=extern}}
 116 BindsTo=afm-link-{{name}}@%i.service
 117 After=afm-link-{{name}}@%i.service
 118 {{/value=extern}}
 119 {{/required-binding}}
 120 {{#required-api}}
 121 {{#value=auto|ws}}
 122 BindsTo=afm-api-{{name}}@%i.service
 123 After=afm-api-{{name}}@%i.service
 124 {{/value=auto|ws}}
 125 {{/required-api}}
 126 {{#provided-api}}
 127 {{#value=ws|auto}}
 128 Requires=afm-api-{{name}}@%i.socket
 129 After=afm-api-{{name}}@%i.socket
 130 {{/value=ws|auto}}
 131 {{/provided-api}}
 132 %nl
 133 [Service]
 134 EnvironmentFile=-@afm_confdir@/unit.env.d/*
 135 SmackProcessLabel=User::App::{{:id}}
 136 SuccessExitStatus=0 SIGKILL
 137 User=%i
 138 Slice=user-%i.slice
 139 #CapabilityBoundingSet=
 140 #AmbientCapabilities=
 141 {{#required-permission.urn:AGL:permission::platform:no-oom}}OOMScoreAdjust=-500{{/required-permission.urn:AGL:permission::platform:no-oom}}
 142 {{#required-permission.urn:AGL:permission::partner:real-time}}IOSchedulingClass=realtime{{/required-permission.urn:AGL:permission::partner:real-time}}
 143 {{#required-permission.urn:AGL:permission::public:display}}SupplementaryGroups=display{{/required-permission.urn:AGL:permission::public:display}}
 144 {{^required-permission.urn:AGL:permission::public:syscall:clock}}SystemCallFilter=~@clock{{/required-permission.urn:AGL:permission::public:syscall:clock}}
 145 %nl
 146 WorkingDirectory=-/home/%i/app-data/{{:id}}
 147 ExecStartPre=/bin/mkdir -p /home/%i/app-data/{{:id}}
 148 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 149 Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}/bin
 150 Environment=LD_LIBRARY_PATH={{:#metadata.install-dir}}/lib
 151 Environment=XDG_DATA_HOME=/home/%i/app-data/{{:id}}
 152 Environment=XDG_CONFIG_HOME=/home/%i/app-data/{{:id}}
 153 Environment=XDG_CACHE_HOME=/home/%i/app-data/{{:id}}
 154 Environment=XDG_RUNTIME_DIR=@afm_users_rundir@/%i
 155 Environment=DBUS_SESSION_BUS_ADDRESS=unix:path=@afm_users_rundir@/%i/bus
 156 SyslogIdentifier=afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 157 StandardInput=null
 158 StandardOutput=journal
 159 StandardError=journal
 160 ;---------------------------------------------------------------------------------
 161 ;----   text/html  application/vnd.agl.native  application/vnd.agl.service    ----
 162 ;---------------------------------------------------------------------------------
 163 {{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 164 {{^content.type=application/vnd.agl.service}}
 165 X-AFM--http-port={{:#metadata.http-port}}
 166 {{/content.type=application/vnd.agl.service}}
 167 Type=notify
 168 ExecStart=/usr/bin/afb-daemon \
 169         --name afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} \
 170         --rootdir={{:#metadata.install-dir}} \
 171         --workdir=/home/%i/app-data/{{id}} \
 172         {{#content.type=application/vnd.agl.service}} \
 173                 --no-httpd \
 174         {{/content.type=application/vnd.agl.service}}{{^content.type=application/vnd.agl.service}} \
 175                 --port={{:#metadata.http-port}} \
 176                 --random-token \
 177                 --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}} \
 178         {{/content.type=application/vnd.agl.service}} \
 179         {{#required-permission.urn:AGL:permission::public:applications:read}}--alias=/icons:{{:#metadata.icons-dir}}{{/required-permission.urn:AGL:permission::public:applications:read}} \
 180         {{#required-api}} \
 181                 {{#value=auto|ws}}--ws-client=unix:@afm_users_rundir@/%i/apis/ws/{{name}}{{/value=auto|ws}} \
 182                 {{#value=dbus}}--dbus-client={{name}}{{/value=dbus}} \
 183                 {{#value=cloud}}--cloud-client={{name}}{{/value=cloud}} \
 184                 {{#value=local}}--binding={{:#metadata.install-dir}}/{{name}}{{/value=local}} \
 185                 {{#value=tcp}}--ws-client=tcp:{{name}}{{/value=tcp}} \
 186         {{/required-api}} \
 187         {{#required-binding}} \
 188                 {{#value=local}}--binding={{:#metadata.install-dir}}/{{name}}{{/value=local}} \
 189                 {{#value=extern}}--binding=@afm_users_rundir@/%i/apis/link/{{name}}{{/value=extern}} \
 190         {{/required-binding}} \
 191         {{#provided-api}} \
 192                 {{#value=auto|ws}}--ws-server=sd:{{name}}{{/value=auto|ws}} \
 193                 {{#value=dbus}}--dbus-server={{name}}{{/value=dbus}} \
 194                 {{#value=tcp}}--ws-server=tcp:{{name}}{{/value=tcp}} \
 195         {{/provided-api}} \
 196         {{#content.type=text/html}}--exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t{{/content.type=text/html}} \
 197         {{#content.type=application/vnd.agl.native}}--exec {{:#metadata.install-dir}}/{{content.src}} @p @t{{/content.type=application/vnd.agl.native}}
 198 {{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 199 ;---------------------------------------------------------------------------------
 200 ;----                 application/x-executable                                ----
 201 ;---------------------------------------------------------------------------------
 202 {{#content.type=application/x-executable}}
 203 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 204 {{/content.type=application/x-executable}}
 205 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 206 ;---------------------------------------------------------------------------------
 207 ; auto start
 208 ;---------------------------------------------------------------------------------
 209 [Install]
 210 WantedBy=afm-user-session@.target
 211 %systemd-unit wanted-by afm-user-session@.target
 212 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 213 %end systemd-unit
 214 ;-------------------------------------------------------------------------------
 215 ;----        P R O V I D E D   A P I S                                      ----
 216 ;-------------------------------------------------------------------------------
 217 {{#provided-api}}
 218 ;-------------------------------------------------------------------------------
 219 ;----        T H E   S E R V I C E   O F   T H E   A P I                    ----
 220 ;-------------------------------------------------------------------------------
 221 %begin systemd-unit
 222 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 223 %systemd-unit system
 224 %systemd-unit service afm-api-{{name}}@
 225 [Unit]
 226 Description=Provides api {{name}} for user %i
 227 X-AFM-API-TYPE={{value}}
 228 Requires=afm-user-setup@%i.service
 229 After=afm-user-setup@%i.service
 230 {{#value=ws|auto}}
 231 Requires=afm-api-{{name}}@%i.socket
 232 After=afm-api-{{name}}@%i.socket
 233 {{/value=ws|auto}}
 234 [Service]
 235 Type=oneshot
 236 RemainAfterExit=yes
 237 {{#value=ws|auto}}
 238 ExecStart=/bin/true
 239 {{/value=ws|auto}}
 240 %end systemd-unit
 241 ;-------------------------------------------------------------------------------
 242 ;----        T H E   S O C K E T   O F   T H E   A P I                      ----
 243 ;-------------------------------------------------------------------------------
 244 {{#value=ws|auto}}
 245 %begin systemd-unit
 246 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 247 %systemd-unit system
 248 %systemd-unit socket afm-api-{{name}}@
 249 [Unit]
 250 Description=Provides websocket api {{name}} for user %i
 251 Requires=afm-user-setup@%i.service
 252 After=afm-user-setup@%i.service
 253 DefaultDependencies=no
 254 [Socket]
 255 SmackLabel=*
 256 SmackLabelIPIn=System
 257 SmackLabelIPOut=System
 258 ListenStream=@afm_users_rundir@/%i/apis/ws/{{name}}
 259 FileDescriptorName={{name}}
 260 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
 261 %end systemd-unit
 262 {{/value=ws|auto}}
 263 {{/provided-api}}
 264 ;-------------------------------------------------------------------------------
 265 ;----        P R O V I D E D   B I N D I N G                                ----
 266 ;-------------------------------------------------------------------------------
 267 {{#provided-binding}}
 268 ;-------------------------------------------------------------------------------
 269 ;----        T H E   S E R V I C E   O F   T H E   B I N D I N G            ----
 270 ;-------------------------------------------------------------------------------
 271 %begin systemd-unit
 272 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 273 %systemd-unit system
 274 %systemd-unit service afm-link-{{name}}@
 275 [Unit]
 276 Description=Provides binding {{name}} for user %i
 277 Requires=afm-user-setup@%i.service
 278 After=afm-user-setup@%i.service
 279 [Service]
 280 Type=oneshot
 281 RemainAfterExit=yes
 282 ExecStart=/bin/ln -sf {{:#metadata.install-dir}}/{{value}} @afm_users_rundir@/%i/apis/link/{{name}}
 283 %end systemd-unit
 284 {{/provided-binding}}
 285 {{/targets}}
 286 ;---------------------------------------------------------------------------------
 287 ; End of file afm-unit.conf mode RELEASE
 288 ;---------------------------------------------------------------------------------